Skip to content

Commit 2070916

Browse files
benjaominghumitos
andauthored
Update README.rst
Co-authored-by: Manuel Kaufmann <humitos@gmail.com>
1 parent 84a26bf commit 2070916

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ This example shows a Jupyter Book project with Read the Docs. You're encouraged
1616
⚙️ `docs/_config.yml <https://github.com/readthedocs-examples/example-jupyter-book/blob/main/docs/_config.yml>`_
1717
This is the `configuration for Jupyter Book <https://jupyterbook.org/en/stable/customize/config.html>`_ which is used to generate a Sphinx-configuration on-the-fly. However, the Sphinx ``conf.py`` file is NOT managed in a git repository, as it is managed by Jupyter Book!
1818
📍 `docs/requirements.txt <https://github.com/readthedocs-examples/example-jupyter-book/blob/main/docs/requirements.txt>`_
19-
These dependencies need to be installed for Jupyter Book to work. If you are familiar with Python, you might notice that the dependencies are *not* `pinned <https://docs.readthedocs.io/en/latest/guides/reproducible-builds.html>`. This is the default method for Jupyter Book - on one hand it gives you the latest version each time Read the Docs builds your documentation; but on the other hand, your build can fail in the future if an incompatible version of ``jupyter-book`` is released.
19+
These dependencies need to be installed for Jupyter Book to work. If you are familiar with Python, you might notice that the dependencies are *not* `pinned <https://docs.readthedocs.io/en/latest/guides/reproducible-builds.html>`_. This is the default method for Jupyter Book - on one hand it gives you the latest version each time Read the Docs builds your documentation; but on the other hand, your build can fail in the future if an incompatible version of ``jupyter-book`` is released.
2020
💡 Extension: `Intersphinx <https://docs.readthedocs.io/en/stable/guides/intersphinx.html>`_
2121
Using this extension, we refer directly to sections in other projects that use Sphinx.
2222
💡 Extension: `sphinx-hoverxref <https://sphinx-hoverxref.readthedocs.io/>`__

0 commit comments

Comments
 (0)