Repository navigation
fix: resolve summary links through intersphinx, nested external types, signature-only types and spaced member spellings - #74
Merged
Conversation
quiet_reference turns unresolved summary and Overrides links into text. At the default priority it ran before intersphinx whenever this extension was listed first, as docs/usage.rst shows, so such links to another Sphinx project stayed text. It now runs at priority 900.
Without compiler metadata, the URL assumed that the mapped prefix was the exact package, so vendor.api.util.Thing under vendor.api became vendor/api/util.Thing.html. The type now starts at the first capitalized name, or after the prefix when no name is capitalized.
Only java:automethod and roles removed spaces and mapped ... to [], so :members: find(java.lang.String, int) and java:autosummary entries with spaces or varargs warned "not found". One helper now normalises java:automethod and java:autofield arguments, java:autosummary lines, :members: and :exclude-members: entries, and role targets.
External Javadoc metadata came only from comment links, so a role to a JDK type that appeared only in signatures or @throws, such as :java:type:`java.util.List`, found no module and stayed unresolved under a {module} mapping. use_model now also reads signature types and throws parts, and an entry with a location is never replaced by an unresolved link.
Contributor
|
Documentation preview for 8b9b42e: https://r4sky0.github.io/sphinx-java-autodoc/pr-preview/pr-74/ |
r4sky0
enabled auto-merge (squash)
November 11, 2026 05:36
r4sky0
added a commit
that referenced
this pull request
Nov 14, 2026
🤖 I have created a release *beep* *boop* --- ## [0.7.0](v0.6.0...v0.7.0) (2026-11-11) ### Features * render more Javadoc HTML and inline tags natively, and highlight <pre> leniently ([#72](#72)) ([6b851cb](6b851cb)) * report implicit inheritance failures as java.inherit and warn about unresolved [@throws](https://github.com/throws) ([#73](#73)) ([a940118](a940118)) ### Bug Fixes * publish files with the umask's permissions, ignore JVM option notices and accept an integer java_release ([#70](#70)) ([99b9a76](99b9a76)) * resolve summary links through intersphinx, nested external types, signature-only types and spaced member spellings ([#74](#74)) ([b75a4ce](b75a4ce)) * show modifiers, field order and <br> summaries as the standard doclet does ([#71](#71)) ([cd7cd85](cd7cd85)) * survive links to type parameters and modules, and table rows without cells ([#69](#69)) ([b4127fc](b4127fc)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: r4sky0 <9093316+r4sky0@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Four cases where a reference that could resolve did not.
docs/usage.rstdescribes the fallback URL rule, the spelling rule and where external locations come from.Evidence
test_intersphinx_resolves_summary_links_before_text_fallbackfails (the link stays plain text). Two new cases oftest_external_urlsfail withutil.Thing.Inner.html.test_manual_role_uses_signature_metadatafails withref.type.test_member_spellings_are_normalised_in_every_directivefails with "not found" warnings.After: all pass.
test_external_locations_come_from_links_throws_and_signatureswas written after the fix and never seen failing.pytest -q145 passed,pre-commit run --all-filespasses,sphinx-build -W --keep-going -n docspasses.Merge Danger
Door: two-way
Blast Radius: links
Links that were plain text or dead start to resolve. The URL fallback relies on Java naming: with no capitalized name in the reference, the type starts right after the mapped prefix, as before. An unresolved link never replaces a known location for the same target.