Skip to content

Commit 2338674

Browse files
committed
Adds reference to the first page in TOC, adds a RTD badge
1 parent 97791c3 commit 2338674

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

README.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
11
Example: Basic Sphinx project for Read the Docs
22
===============================================
33

4+
.. image:: https://readthedocs.org/projects/example-sphinx-basic/badge/?version=latest
5+
:target: https://example-sphinx-basic.readthedocs.io/en/latest/?badge=latest
6+
:alt: Documentation Status
7+
48
.. 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
59
6-
This example shows the an integration of a basic Sphinx 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>`_.
10+
This example shows the an integration of a basic Sphinx 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>`__.
711

812
📚 `docs/ <https://github.com/readthedocs-examples/example-sphinx-basic/blob/main/docs/>`_
913
A basic Sphinx project lives in ``docs/``, it was generated using Sphinx defaults. All the ``*.rst`` make up sections in the documentation.
@@ -75,5 +79,5 @@ If you are copying this code in order to get started with your documentation, yo
7579
Read the Docs tutorial
7680
----------------------
7781

78-
To get started with Read the Docs, you may also refer to the `Read the Docs tutorial <https://docs.readthedocs.io/en/stable/tutorial/>`_.
82+
To get started with Read the Docs, you may also refer to the `Read the Docs tutorial <https://docs.readthedocs.io/en/stable/tutorial/>`__.
7983
It provides a full walk-through of building an example project similar to the one in this repository.

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,5 +20,6 @@ Contents
2020

2121
.. toctree::
2222

23+
Home <self>
2324
usage
2425
api

0 commit comments

Comments
 (0)