Skip to content

Add nbsphinx-link to installation instructions #40

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

Merged
The9Cat merged 3 commits into from
Nov 24, 2025
Merged

Add nbsphinx-link to installation instructions #40

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c997a68
Add nbsphinx-link to installation instructions
The9Cat Nov 24, 2025
a18d8ca
Update README.rst
The9Cat Nov 24, 2025
3d13107
Update README with nbsphinx-link installation details
The9Cat Nov 24, 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
4 changes: 4 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,18 @@ install it along with the ReadTheDocs theme, run the following commands:

pip install sphinx
pip install sphinx-rtd-theme
pip install nbsphinx-link

For a Linux system with `apt` (e.g. Ubuntu), you can do:

::

apt-get install python3-sphinx python3-sphinx-rtd-theme

Note: The `nbsphinx-link` package is needed to process Python notebook examples
but is not available via apt. It may be installed using pip:

pip install nbsphinx-link

Compile the documentation
-------------------------
Expand Down