Skip to content

Commit 8bc516d

Browse files
committed
s/Github/GitHub, add more details about including README.rst
1 parent 98bc25f commit 8bc516d

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.rst

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ Example: Jupyter Book for Read the Docs
55
:target: https://example-jupyter-book.readthedocs.io/en/latest/?badge=latest
66
:alt: Documentation Status
77

8-
.. This README.rst should work on Github and is also included in the Sphinx documentation project in docs/ - therefore, README.rst uses absolute links for most things so it renders properly on GitHub
8+
.. This README.rst should work on GitHub and is also included in the Sphinx documentation project in docs/ - therefore, README.rst uses absolute links for most things so it renders properly on GitHub
99
1010
This example shows a Jupyter Book project with Read the Docs. You're encouraged to view it to get inspiration and copy & paste from the files in the source code. If you are using Read the Docs for the first time, have a look at the official `Read the Docs Tutorial <https://docs.readthedocs.io/en/stable/tutorial/index.html>`__. If you are using Jupyter Book for the first time, have a look at the `official Jupyter Book documentation <https://jupyterbook.org/en/stable/>`_.
1111

1212
📚 `docs/ <https://github.com/readthedocs-examples/example-jupyter-book/blob/main/docs/>`_
13-
A basic Jupyter Book project lives in ``docs/``. All the ``*.md`` make up sections in the documentation.
13+
A basic Jupyter Book project lives in ``docs/``. All the ``*.md`` make up sections in the documentation, ``intro.md`` is the starting page and includes this ``README.rst``.
1414
⚙️ `.readthedocs.yaml <https://github.com/readthedocs-examples/example-jupyter-book/blob/main/.readthedocs.yaml>`_
1515
Read the Docs Build configuration is stored in ``.readthedocs.yaml``.
1616
⚙️ `docs/_config.yml <https://github.com/readthedocs-examples/example-jupyter-book/blob/main/docs/_config.yml>`_
@@ -20,9 +20,9 @@ This example shows a Jupyter Book project with Read the Docs. You're encouraged
2020
🔢 Git tags versioning
2121
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/>`__.
2222
📜 `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).
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).
2424
⁉️ Questions / comments
25-
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>`_.
25+
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>`_.
2626

2727

2828
Example Project usage
@@ -51,8 +51,10 @@ If you are new to Read the Docs, you may want to refer to the `Read the Docs Use
5151

5252
If you are copying this code in order to get started with your documentation, you need to:
5353

54-
#. use your existing project repository or create a new repository on Github, GitLab, Bitbucket or another host supported by Read the Docs
54+
#. use your existing project repository or create a new repository on GitHub, GitLab, Bitbucket or another host supported by Read the Docs
5555
#. copy ``.readthedocs.yaml`` and the ``docs/`` folder into your project.
56+
#. if you want to have a README on GitHub, create a ``README.rst`` which will be included in ``index.md``.
57+
#. if you *do not* want your README from GitHub included in the docs, edit `ìndex.md`` and remove the ``eval-rst`` block that includes it.
5658
#. if you don't already have a ``.gitignore``, use the one from the project file -- otherwise add these lines::
5759

5860
/docs/conf.py

0 commit comments

Comments
 (0)