Repository navigation
Put example and tutorial pages in the docs navigation - #2968
Merged
Merged
Conversation
Example pages and tutorial listing/diff pages were marked :orphan:, so the sidebar didn't know where they belong and showed the About section instead. Each parent page now lists them in a hidden toctree. The examples gallery also gets entries for four examples it was missing, and six thumbnail links that pointed at pages that don't exist (four of them absolute paths, which 404 on the versioned docs site) are fixed. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.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.
Closes #2274
Navigation
230 pages started with
:orphan:, so they weren't in any table of contents: 125 example pages and 105 tutorial listing and diff pages. Sphinx didn't know where they belonged, and the sidebar showed the About section open instead of where the reader was.Each parent page now lists its pages in a
:hidden:toctree, and the:orphan:lines are gone. The parent pages look the same.-Wdocs build catches a missing one.The remaining four orphans are left as they are:
404.rst,_archive/diversity.rst(excluded from the build),api_docs/gl/utils.rstandcommunity/games/game_jam_2020.rst.Examples gallery fixes
controller, after the other controller examplegui_exp_scroll_area,gui_exp_animationsandgui_exp_animations_2, under Experimental Widgetsperformance_statistics_example.htmlandexample-sprite-collect-coins-diff-levels.htmlused the page's label instead of its file name.platformer_tutorial.html,gui_own_widgets.html,gui_own_layout.htmlandpymunk_platformer_tutorial.htmlpointed at pages that aren't inexample_code/./tutorials/...), which go to the domain root and 404 on the versioned site, for example https://api.arcade.academy/tutorials/card_game/index.html. All gallery links are now relative.Testing
-Wpasses.🤖 Generated with Claude Code