Repository navigation
Conversation
Collaborator
|
As we discussed before, the videos should not be included in this PR. We can add the CI job to generate them on the fly in a follow-up |
Collaborator
Author
|
Done |
amacati
reviewed
Oct 18, 2026
Comment on lines
+63
to
+70
| def test_examples_in_docs(): | ||
| """Every example script has a section in the example docs, and every section has a script.""" | ||
| directive = re.compile(r'^--8<-- example "examples/(.+)"$', re.MULTILINE) | ||
| pages = DOCS_EXAMPLES_DIR.glob("*.md") | ||
| documented = {path for page in pages for path in directive.findall(page.read_text())} | ||
| scripts = {path.relative_to(EXAMPLES_DIR).as_posix() for path in EXAMPLES_DIR.rglob("*.py")} | ||
| assert not scripts - documented, f"Missing from docs/examples: {sorted(scripts - documented)}" | ||
| assert not documented - scripts, f"Stale in docs/examples: {sorted(documented - scripts)}" |
Collaborator
There was a problem hiding this comment.
Why is this here? We are already testing the examples outside the docs, aren't we?
Collaborator
Author
There was a problem hiding this comment.
This is not testing the examples, rather it tests if all examples are in the docs and all doc examples actually exist. We could also move this check into the docs build if you prefer. Automatically building the docs from the examples folder doesn't work, since we have ordered the docs to be easier digestible.
Co-authored-by: Martin Schuck <57562633+amacati@users.noreply.github.com>
amacati
approved these changes
Oct 20, 2026
Closed
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.
With this PR, the docs contain all examples (tested with new test). To make it less crowded (#131), the docs are strucuted as the example folders. Also, instead of having the information per example twice, we only have the docstring, which is also written into the docs during building (new script for that). Since the code of some examples is long, the code is now collapsible.
Additionally, I added some quality of life fixes, such as a --plot flag with no plotting when running regularly (would crash in the base env) and unifying the naming inside the examples (all now use
trajectory()for the reference and similar changes).This PR turned out longer than intended. Most of it is just shifting things around though. If I should split this into multiple PRs, lmk.