docs(nav): give Plotting Prelude a title and put the four chapters in the sidebar - #584
Merged
Merged
Conversation
… the sidebar Two linked defects in Getting Started. The first cell of tutorials/plotting_prelude.ipynb was a `raw` cell, not markdown. nbsphinx passes a raw cell through verbatim, so "# Plotting Prelude" never became a heading: the page had no title, rendered the hash as literal text glued onto the first paragraph, and appeared in the toctree as "<no title>". It is the only one of the four Getting Started notebooks with this defect; the other three open with markdown. The second: docs/source/getting_started.rst contained no toctree at all. The four notebooks were body-text :doc: links, which render as a list but wire nothing into the navigation, so the sidebar fell back to the page's own sections - "Quick start / The two APIs / Decision Map" - instead of the four chapters. They had to be fixed together: a toctree entry takes the target's title, so Plotting Prelude would have shown as "<no title>" in the sidebar. Verified on a full build: <title> : "Plotting Prelude - AAanalysis" (was <no title>) first h1 : "Plotting Prelude" (was none) literal "# Plotting Prelude" in the body: gone sidebar : the four chapters, each linking to its generated page Co-Authored-By: Claude Fable 5.1 <[email protected]>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #584 +/- ##
=======================================
Coverage 95.39% 95.39%
=======================================
Files 222 222
Lines 23387 23387
Branches 4073 4073
=======================================
Hits 22309 22309
Misses 631 631
Partials 447 447
🚀 New features to boost your workflow:
|
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.
Two linked defects in Getting Started.
1. Plotting Prelude had no title. The first cell of
tutorials/plotting_prelude.ipynbwas arawcell, not markdown. nbsphinx passes a raw cell through verbatim, so# Plotting Preludenever became a heading: the page had no title, rendered the hash as literal text glued onto the first paragraph, and appeared in the toctree as<no title>. It is the only one of the four Getting Started notebooks with this defect — the other three open with markdown.2. The sidebar showed the wrong things.
docs/source/getting_started.rstcontained no toctree at all. The four notebooks were body-text:doc:links, which render as a list but wire nothing into navigation, so the sidebar fell back to the page's own sections (Quick start / The two APIs / Decision Map) instead of the four chapters.They had to be fixed together: a toctree entry takes its target's title, so Plotting Prelude would have appeared as
<no title>in the sidebar.Verification (full build, inspecting the generated HTML)
🤖 Generated with Claude Code