Skip to content

Restructure example docs - #138

Open
ratheron wants to merge 3 commits into
mainfrom
fix.docs
Open

ratheron wants to merge 3 commits into
mainfrom
fix.docs

Conversation

@ratheron

Copy link
Copy Markdown
Collaborator

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.

@ratheron
ratheron requested a review from amacati October 13, 2026 21:19
@amacati

amacati commented Oct 14, 2026

Copy link
Copy Markdown
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

@ratheron

Copy link
Copy Markdown
Collaborator Author

Done

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants