Skip to content

docs(notebooks): restructure notebook based docs - #420

Open
tachyonicClock wants to merge 3 commits into
adaptive-machine-learning:mainfrom
tachyonicClock:rdd_reviewed
Open

tachyonicClock wants to merge 3 commits into
adaptive-machine-learning:mainfrom
tachyonicClock:rdd_reviewed

Conversation

@tachyonicClock

@tachyonicClock tachyonicClock commented Sep 18, 2026

Copy link
Copy Markdown
Collaborator

This is a few changes:

  • Replace .ipynb with 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:

image
  • The "documentation" jobs now run the notebooks rather than the "tests" job.

  • We have the capability to link User Guide documentation 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.

image
  • Each domain has a basic stub with the relevant notebooks integrated. Some notebooks have been split into multiple parts.
image

Future Work

  • Some notebooks outputs look worse. The change switched notebook render pipelines from nbsphinx to myst-nb.

    • Old:
image
  • New:
image
  • sklearn has a download notebook feature:
image

@hmgomes

hmgomes commented Sep 22, 2026

Copy link
Copy Markdown
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
Also, building the documentation would mean running the notebooks now, which makes it slightly slower to build the documentation, correct?

…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

Copy link
Copy Markdown
Collaborator Author

Added redirects: https://github.com/adaptive-machine-learning/CapyMOA/pull/420/changes#diff-85933aa74a2d66c3e4dcdf7a9ad8397f5a7971080d34ef1108296a7c6b69e7e3R169.
The only large build time is during release where it matters less. The pull request time is actually less because now the notebook documentation tests and the main repository tests run in parallel.

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

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