Repository navigation
Docs: list all examples w/ unique numbering & sync w/ tests - #97
Merged
sadielbartholomew merged 48 commits intoApr 14, 2025
Merged
sadielbartholomew merged 48 commits into
sadielbartholomew merged 48 commits into
Conversation
Member
Author
|
Merging now since this PR will become too bloated if I add more docs fix-up/improv. and I need to get the bug fixes merged... |
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.
Adds a table of contents listing all examples in numbered order (as well as an index page overall TOC), since previously they could only be accessed via themed pages. For a more self-contained structuring, I've made an individual file with a sub-title containing the code snippet and displaying the image (in better RST formatting) which can be included in those themed pages, or in any useful place, via the
..include::directive, as applied throughout this PR. I have also added titles and contents to each example for some further context.This PR includes (re)assignment of (sub-)numbering for some docs examples, since there were some with duplicate numbers e.g. there were two different code blocks called 'Example 21' with two different plots, plus some had no numbering and just a descriptive title. Now every example has a unique number, though to avoid disparate numbering of similar examples some are assigned 'a, b, c,' etc.
Not pushing a re-build of the HTML docs yet, until all bug fixes are in to fix the remaining incorrect plots.
Follow-on work
After this PR, at least I want to also, pre-release: