Skip to content

switch from Sphinx to Jupyter Book #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

switch from Sphinx to Jupyter Book #6

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1e1cd69
start switching to jupyter book
mdtanker Jul 16, 2025
6285d7e
Merge branch 'main' into jupyter_book
mdtanker Jul 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -277,7 +277,7 @@ Leave a comment in the PR and we'll help you out.

### Documentation

The Docs are build with `Sphinx` and `Read the Docs`.
The Docs are build with [Jupyer Book](https://jupyterbook.org/en/stable/intro.html) and hosted on [Read the Docs](https://readthedocs.org/).

> **Note:** The docs are automatically built on PR's by `RTD`, but it's good practice to build them manually before a PR, to check them for errors.

Expand Down