From c997a683532452f0c3d379e133e7c23e07357804 Mon Sep 17 00:00:00 2001 From: Martin Weinberg Date: Mon, 24 Nov 2025 17:30:21 -0500 Subject: [PATCH 1/3] Add nbsphinx-link to installation instructions --- README.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index ed2a222..03a7e6a 100644 --- a/README.rst +++ b/README.rst @@ -16,12 +16,13 @@ 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 + apt-get install python3-sphinx python3-sphinx-rtd-theme nbsphinx-link From a18d8ca9203b9fd45ddc71e5dce565b5d67510ca Mon Sep 17 00:00:00 2001 From: Martin Weinberg Date: Mon, 24 Nov 2025 17:36:07 -0500 Subject: [PATCH 2/3] Update README.rst Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- README.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 03a7e6a..a20c952 100644 --- a/README.rst +++ b/README.rst @@ -22,9 +22,11 @@ For a Linux system with `apt` (e.g. Ubuntu), you can do: :: - apt-get install python3-sphinx python3-sphinx-rtd-theme nbsphinx-link + apt-get install python3-sphinx python3-sphinx-rtd-theme + Note: The `nbsphinx-link` package is not available via apt and should be installed using pip: + pip install nbsphinx-link Compile the documentation ------------------------- From 3d13107cf5bc1bc0a900e6a81d791251e1b07734 Mon Sep 17 00:00:00 2001 From: Martin Weinberg Date: Mon, 24 Nov 2025 17:38:17 -0500 Subject: [PATCH 3/3] Update README with nbsphinx-link installation details Clarify installation note for nbsphinx-link package. --- README.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index a20c952..2f52e32 100644 --- a/README.rst +++ b/README.rst @@ -24,7 +24,8 @@ 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 not available via apt and should be installed using pip: + 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