Skip to content

Commit 152ffef

Browse files
committed
Mention usage.rst as well
1 parent ae73375 commit 152ffef

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Example: Basic Sphinx project for Read the Docs
22
===============================================
33

4-
This example shows the following basic integration with Read the Docs. You're encouraged to view it to get inspiration and copy & paste from the files in the source code.
4+
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>`_.
55

66
📚 `docs/ <https://github.com/readthedocs-examples/example-sphinx-basic/blob/main/docs/>`_
77
A basic Sphinx project lives in ``docs/``, it was generated using Sphinx defaults
@@ -11,6 +11,8 @@ This example shows the following basic integration with Read the Docs. You're en
1111
Python dependencies are `pinned <https://docs.readthedocs.io/en/latest/guides/reproducible-builds.html>`_ (uses `pip-tools <https://pip-tools.readthedocs.io/en/latest/>`_)
1212
💡 `docs/api.rst <https://github.com/readthedocs-examples/example-sphinx-basic/blob/main/docs/api.rst>`_
1313
By listing the Python module ``lumache`` in ``autosummary``, Sphinx will automatically scan this module and generate API docs.
14+
💡 `docs/usage.rst <https://github.com/readthedocs-examples/example-sphinx-basic/blob/main/docs/usage.rst>`_
15+
Sphinx can automatically extract API documentation directly from Python modules, using for instance ``autofunction``.
1416
💡 `lumache.py <https://github.com/readthedocs-examples/example-sphinx-basic/blob/main/lumache.py>`_
1517
API docs are generated for this example Python module - they use *docstrings* directly in the documentation, notice how this shows up in the rendered documentation.
1618
🔢 Git tags versioning

0 commit comments

Comments
 (0)