Repository navigation
feat: render more Javadoc HTML and inline tags natively, and highlight <pre> leniently - #72
Merged
Merged
Conversation
A <pre> without lang was highlighted strictly as Java, so result tables and other plain text warned misc.highlighting_failure (20 warnings in the showcase), although Javadoc never highlights <pre>. Such blocks keep Java but set force. Blocks with an explicit lang, including snippets, stay strict.
2<sup>31</sup> rendered as 231, headings, <tt> and <dl> only warned, and
{@index}, {@summary} and {@systemProperty} appeared literally with
braces. <sup> and <sub> now become superscript and subscript, <h1> to
<h6> a rubric, <tt>, <kbd> and <samp> literals, <var>, <cite> and <dfn>
emphasis, <small> plain text, and <dl>, <dt> and <dd> a definition
list. The doclet emits an index term and a summary as text and a
system property as code, as the standard doclet shows them.
Contributor
|
Documentation preview for c49fd1d: https://r4sky0.github.io/sphinx-java-autodoc/pr-preview/pr-72/ |
r4sky0
enabled auto-merge (squash)
November 11, 2026 06:23
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
Common Javadoc that was dropped, shown raw or warned about now renders as native nodes.
2<sup>31</sup>,<sub>231and a warning<h1>to<h6><dl>,<dt>,<dd><tt>,<kbd>,<samp><var>,<cite>,<dfn><small>{@index term}{@summary text}{@systemProperty name}<pre>withoutlang<pre>with alangattribute still warns when the text does not match the language.Widgetfixture comment gains a heading, a definition list,<sup>,<kbd>and{@systemProperty}, so the browser checks cover the new rendering.docs/javadoc-support.rstand the limits indocs/compatibility.rstare updated.Evidence
test_more_javadoc_html_and_inline_tags_render_nativelyfails with three diagnostics.test_preformatted_text_without_lang_is_highlighted_lenientlyfails, and a strict build reportsmisc.highlighting_failure.After: both pass.
pytest -q141 passed,pre-commit run --all-filespasses,sphinx-build -W --keep-going -n docspasses.java.htmlwarnings and from 20 to 0 highlighting failures, and the browser checks pass in all five themes. Neither was run on this branch alone.showcase.jsonalone. Counts below the baseline pass; lowering it follows separately.Merge Danger
Door: two-way
Blast Radius: rendering
Comments that used these elements change appearance on every page. Headings do not enter the page's table of contents. Content directly inside
<dl>, outside<dt>and<dd>, warns.