Fix MkDocs API reference navigation - #4
Merged
Conversation
Wire generated reference pages into site nav via literate-nav (remove conflicting static nav). Follow mkdocstrings recipe: __init__ modules become index.md, nav paths relative to reference/, skip private modules. Enable show_root_heading for clearer API pages. Co-authored-by: Brad Barnett <bdbarnett@users.noreply.github.com>
Contributor
|
Bugbot is not enabled for your account, so this pull request was not reviewed. Enable Bugbot in the Cursor dashboard to get automatic reviews on future PRs. |
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.
Generated API reference pages existed but were orphaned — not linked in site navigation.
Root cause
mkdocs.ymlhad a staticnav:block that excluded generatedreference/pagesmkdocs_gen_ref_pages.pyused incorrect paths (e.g.reference.mdinstead ofreference/palettes/index.md) and broken SUMMARY linksFix
nav:; drive navigation fromdocs/SUMMARY.mdvia literate-navreference/todocs/SUMMARY.mdindex.mdfor packages, paths relative toreference/, skip_modulesshow_root_heading/show_symbol_type_*mkdocstrings optionsAfter rebuild, sidebar shows API Reference → palettes → cube / material_design / wheel with full docstring content.