Skip to content

Commit 84a26bf

Browse files
committed
Rework the displayed features for README.rst (TODO: add links to conf.py lines) + create intro.md with independent contents
1 parent 8bc516d commit 84a26bf

File tree

2 files changed

+17
-9
lines changed

2 files changed

+17
-9
lines changed

README.rst

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,14 @@ This example shows a Jupyter Book project with Read the Docs. You're encouraged
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>`_
1919
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.
20-
🔢 Git tags versioning
21-
We `version the docs <https://docs.readthedocs.io/en/stable/versions.html>`_ by adding a git tag for every release of the example project. All releases and their version numbers are visible on `example-jupyter-book.readthedocs.io <https://example-jupyter-book.readthedocs.io/en/latest/>`__.
22-
📜 `README.rst <https://github.com/readthedocs-examples/example-jupyter-book/blob/main/README.rst>`_
23-
Contents of this ``README.rst`` are visible on GitHub and included on `the documentation index page <https://example-jupyter-book.readthedocs.io/en/latest/>`_ (Don't Repeat Yourself).
20+
💡 Extension: `Intersphinx <https://docs.readthedocs.io/en/stable/guides/intersphinx.html>`_
21+
Using this extension, we refer directly to sections in other projects that use Sphinx.
22+
💡 Extension: `sphinx-hoverxref <https://sphinx-hoverxref.readthedocs.io/>`__
23+
A floating window (also known as a "tooltip" or "modal dialogue") appears when the mouse curser hovers a cross references to another section of the documentation or another documentation project referenced with Intersphinx.
24+
🔢 Simplified versioning
25+
In this example, we maintain a single version of the rendered documentation by automatically building and rendering everything that is added to the ``main`` branch. This is different from many software projects where several `versions of the docs <https://docs.readthedocs.io/en/stable/versions.html>`_ may be published for each new release.
26+
🔢 Pull Request builds
27+
Every time a change in a Pull Request on the GitHub repository happens, users can open `an automatically built Pull Request preview <https://docs.readthedocs.io/en/stable/pull-requests.html>`__.
2428
⁉️ Questions / comments
2529
If you have questions related to this example, feel free to can ask them as a GitHub issue `here <https://github.com/readthedocs-examples/example-jupyter-book/issues>`_.
2630

docs/intro.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,19 @@
1-
```{eval-rst}
2-
.. include:: ../README.rst
3-
```
1+
# Jupyter Book on Read the Docs
2+
3+
This example shows a Jupyter Book project built and published on Read the Docs. You're encouraged to view it to get inspiration and copy & paste from the files in [the source code][github]. If you are using Read the Docs for the first time, have a look at the official [Read the Docs Tutorial][tutorial]. If you are using Jupyter Book for the first time, have a look at the [official Jupyter Book documentation][jb-docs].
44

5-
# Welcome to your Jupyter Book
5+
# Jupyter Book examples
66

77
This is a small sample book to give you a feel for how book content is
88
structured.
99
It shows off a few of the major file types, as well as some sample content.
10-
It does not go in-depth into any particular topic - check out [the Jupyter Book documentation](https://jupyterbook.org) for more information.
10+
It does not go in-depth into any particular topic - check out [the Jupyter Book documentation][jb-docs] for more information.
1111

1212
Check out the content pages bundled with this sample book to see more.
1313

1414
```{tableofcontents}
1515
```
16+
17+
[github]: https://github.com/readthedocs-examples/example-jupyter-book/ "GitHub source code repository for the example project"
18+
[tutorial]: https://docs.readthedocs.io/en/stable/tutorial/index.html "Official Read the Docs Tutorial"
19+
[jb-docs]: https://jupyterbook.org/en/stable/ "Official Jupyter Book documentation"

0 commit comments

Comments
 (0)