docs(notebooks): restructure notebook based docs - #420
Open
tachyonicClock wants to merge 3 commits into
Open
tachyonicClock wants to merge 3 commits into
tachyonicClock wants to merge 3 commits into
Conversation
tachyonicClock
force-pushed
the
rdd_reviewed
branch
from
September 18, 2026 00:02
5c116d9 to
54b2111
Compare
Collaborator
|
that is a good way to restructure the notebook tutorials. Would it be possible to redirect the old links to the new locations of the notebooks? Just for backwards capability |
…tions The notebooks restructure moved notebooks/*.ipynb into domain subfolders (notebooks/01_classifier/, notebooks/02_drift/, etc.), which broke any external link to the old flat page URLs. sphinx-reredirects generates static meta-refresh stubs at the old paths pointing at the new ones.
tachyonicClock
force-pushed
the
rdd_reviewed
branch
from
September 22, 2026 04:13
bbc6619 to
899a21e
Compare
Collaborator
Author
|
Added redirects: https://github.com/adaptive-machine-learning/CapyMOA/pull/420/changes#diff-85933aa74a2d66c3e4dcdf7a9ad8397f5a7971080d34ef1108296a7c6b69e7e3R169. |
sphinx_markdown_builder has no visitor for docutils' generic `admonition`
node (used by `{admonition}` directives with a custom title, e.g. the
"See also" boxes on the notebook index pages), so it dropped the whole
subtree and Sphinx's warnings-as-errors build failed.
This branch has not been deployed
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.
This is a few changes:
Replace
.ipynbwith an alternative notebook format that looks more like plain python (jupytext py:percent). We no longer commit images, tables, etc to the repository. This makes reading diffs easier and lets agents write/read notebooks better.Should fix this:
The "documentation" jobs now run the notebooks rather than the "tests" job.
We have the capability to link
User Guidedocumentation to API documentation easier.The on release action will build the full notebooks but the on pull requests action will use the fast mock data. The build artifact for pull requests will generate the result for the fast mock data.
Organized the "Tutorials" into a "User Guide" with research domain based sections. I believe we will produce better documentation faster with this structure.
Future Work
Some notebooks outputs look worse. The change switched notebook render pipelines from
nbsphinxtomyst-nb.