Optionally build documentation in small HTML files#35
Merged
teddych merged 1 commit intoteddych:masterfrom Feb 6, 2026
Merged
Conversation
Add build target 'chunked-doc' for cmake and make. This calls pandoc in "chunked HTML" mode and creates a directory 'chunkedhtml/$LANG/' that contains multiple HTML files instead of a monolithic one. The output is intended for future use in the web interface like an "online help" system. It is unsuitable as a standalone documentation due to limitations of pandoc and does *not* replace the existing doc build target.
Contributor
Author
|
I see the two CI tests failing but I don't understand how they relate to the changes in my pull request. Please let me know what I did wrong. |
Owner
|
This is not introduced by you. And a fix is on the way. |
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
2 participants
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.
Add build target 'chunked-doc' for cmake and make. This calls pandoc in "chunked HTML" mode and creates a directory 'chunkedhtml/$LANG/' that contains multiple HTML files instead of a monolithic one.
The output is intended for future use in the web interface like an "online help" system. It is unsuitable as a standalone documentation due to limitations of pandoc and does not replace the existing doc build target.
I shifted level 1 headlines (except the first one) in $LANG/index.md to level 2: The file splitting works on headline level and creates one HTML file per level 1 headline. Without the shifts, the splitting would be too fine grained.
The naming scheme of the HTML files is currently pandoc's default. It can be adapted to fit future needs.