support display titles for documentation files - #39
Open
tylergibbs1 wants to merge 1 commit into
Open
Conversation
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
1 participant
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
this adds an optional FileTitle block for a human-facing documentation title. source filenames still determine generated paths, links, image hashing, and file priority, so existing behavior remains compatible.
the title is used in page headings, tables of contents, sidebars, and cheat sheets. this gives projects such as bosl2 a way to present standard-library topics without suggesting that users should import internal source files individually.
this is the generator support needed for BelfrySCAD/BOSL2#1889.
testing
uv run pytest -q
303 passed and 12 skipped.