Skip to content

Add notebook rendering to docs#130

Open
raar1 wants to merge 1 commit intomainfrom
add_notebook_rendering
Open

Add notebook rendering to docs#130
raar1 wants to merge 1 commit intomainfrom
add_notebook_rendering

Conversation

@raar1
Copy link
Collaborator

@raar1 raar1 commented Mar 2, 2026

This adds notebook rendering to the documentation page under an Examples heading. I found errors in the existing Griftpark notebooks so I didn't add them for now. All the Amersfoort notebooks should be there and seem to render ok.

Note that it is not possible to render notebooks from examples/ directly in a portable fashion (see MiBiPreT/mibitrans#141) so currently there is a separate /docs/examples directory that you must copy notebooks to if you want them to be included in the docs. In future there may be a better solution. If it's really annoying, we could think about a script to automatically copy notebooks over, but this is likely to confuse people so deliberately and explicitly choosing to copy certain notebooks still seems like a better option.

You can test the rendering locally by running pip install .[doc] to get the new docs dependencies down, and then mkdocs serve

@sonarqubecloud
Copy link

sonarqubecloud bot commented Mar 2, 2026

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.

1 participant