Re-implement page rendering #7
Merged
Conversation
This file contains 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
Rather than trying to re-use the existing SectNode to implement arbitrary pages, introduce a dedicated PageNode type to handle them. This way, we don't introduce errant whitespace in the resulting Asciidoc. The trickiest thing here is that we now handle the level of section titles by using the existing depth keyword argument. The current source and expected output (minus extra whitespace) of our indexpage.xml and examples_page.xml are used as text fixtures to ensure there are no regressions there.
|
The title depth isn't quite right as the "Interrupt Numbers" section in the |
Rather than having a mix of depths and hard-coded levels for certain titles, rely entirely on a `depth` keyword argument passed to `to_asciidoc` which dictates the current level of any node. It is a parent node's responsibility to increase the depth when rendering a child that introduces a new level (e.g. a detailed description inside a module). This way, we can render the Doxygen index starting at depth 2 and any arbitrary pages (e.g. the Examples page) at depth 1. This also fixes the level of `<title>`s within `<sect1>`s (e.g. the "Interrupt Numbers" section of hardware_irq).
|
With 28b49db, the title depth is now fixed, see (note the small italic text "Interrupt Numbers" in "Before" compared to the proper subheading in "After"):
|
nathan-contino
approved these changes
Aug 20, 2024
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.
Rather than trying to re-use the existing SectNode to implement arbitrary pages, introduce a dedicated PageNode type to handle them. This way, we don't introduce errant whitespace in the resulting Asciidoc.
The trickiest thing here is that we now handle the level of section titles by using the existing depth keyword argument.
The current source and expected output (minus extra whitespace) of our indexpage.xml and examples_page.xml are used as text fixtures to ensure there are no regressions there.