Skip to content

Commit 49aca7e

Browse files
committed
Add comment about README.rst rendered on GH
1 parent 152ffef commit 49aca7e

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

README.rst

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

4+
.. 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
5+
46
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>`_.
57

68
📚 `docs/ <https://github.com/readthedocs-examples/example-sphinx-basic/blob/main/docs/>`_

0 commit comments

Comments
 (0)