Repository navigation
feat: report implicit inheritance failures as java.inherit and warn about unresolved @throws - #73
Merged
Merged
Conversation
Most extraction warnings in ordinary projects are "Cannot inherit" for overrides of JDK methods such as toString, whose sources cannot be added. They shared java.extract with unresolved links and malformed Javadoc, so silencing them hid real problems. <diagnostic> gains an optional kind, inherit or extract, which Sphinx uses as the warning subtype, so suppress_warnings = ["java.inherit"] works. The schema stays version 1; read_model validates the kind. Explicit inheritDoc failures stay extract because they leave a marker in the output.
"Unsupported block tag UNKNOWN_BLOCK_TAG" hid which tag was meant; the warning now names the tag as written, such as @todo. A @throws or @exception name that does not resolve, such as a misspelled exception, now warns like an unresolved {@link}; the part is unchanged.
Contributor
|
Documentation preview for 4a20a56: https://r4sky0.github.io/sphinx-java-autodoc/pr-preview/pr-73/ |
r4sky0
enabled auto-merge (squash)
November 11, 2026 06: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
Extraction warnings that the user cannot fix get their own category, and two warnings say what is wrong.
suppress_warnings = ["java.inherit"]now silences these and keeps the rest.<diagnostic>gains an optionalkind:inherit, orextractwhen absent. Readers reject other kinds. The attribute is additive in schema 1;docs/schema.mdanddocs/troubleshooting.rstdescribe it.{@inheritDoc}staysjava.extract, because it leaves a marker in the output.--warnings-as-errorsstill fails on every diagnostic.java.extract8 andjava.inherit98.Evidence
test_implicit_inheritance_warnings_have_their_own_category,test_model_accepts_only_known_diagnostic_kindsandtest_unresolved_throws_names_warn_like_linksfail.test_unknown_block_tags_still_warnexpected the old text.After: all pass.
pytest -q142 passed,pre-commit run --all-filespasses,sphinx-build -W --keep-going -n docspasses.showcase/build.pyon this branch: every category equals the new baseline in Furo, Read the Docs and Alabaster. Lumina added one local warning, "npx not found", because Node was not onPATHon the machine used.Merge Danger
Door: two-way
Blast Radius: warnings
An upgrade can turn a passing
-Wbuild red in two ways:java.extractto hide "Cannot inherit" sees those warnings again until it addsjava.inherit.@throwsname that does not resolve now warns.If the first counts as breaking, the title needs
feat!.