Skip to content

Commit 3ca4fac

Browse files
committed
Improve introduction and overview, use a couple of generic sentences useful in other example projects
1 parent 1967ce7 commit 3ca4fac

File tree

1 file changed

+20
-12
lines changed

1 file changed

+20
-12
lines changed

README.rst

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

4-
This example shows the following basic integration with Read the Docs:
5-
6-
* A basic Sphinx project lives in ``docs/`` 📚
7-
* Read the Docs Build configuration is stored in ``.readthedocs.yaml`` ⚙️
8-
* Python dependencies are `pinned <https://docs.readthedocs.io/en/latest/guides/reproducible-builds.html>`_ 📍
9-
* Auto-generated API docs for a Python module called ``lumache`` 💡
10-
* Sphinx documentation integrates Python docstrings directly from ``lumache`` 💡
11-
* A basic versioning mechanism with git tags 🔢
12-
* Contents of this ``README.rst`` are visible on Github and included on `the documentation index page <https://example-sphinx-basic.readthedocs.io/en/latest/>`_ (Don't Repeat Yourself) 📜
13-
* 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-sphinx-basic/issues>`_. ⁉️
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.
5+
6+
📚 `docs/ <https://github.com/readthedocs-examples/example-sphinx-basic/blob/main/docs/>`_
7+
A basic Sphinx project lives in ``docs/``, it was generated using Sphinx defaults
8+
⚙️ `.readthedocs.yaml <https://github.com/readthedocs-examples/example-sphinx-basic/blob/main/.readthedocs.yaml>`_
9+
Read the Docs Build configuration is stored in ``.readthedocs.yaml`` (configuration-as-code)
10+
📍 `docs/requirements.txt <https://github.com/readthedocs-examples/example-sphinx-basic/blob/main/docs/requirements.txt>`_ and `docs/requirements.in <https://github.com/readthedocs-examples/example-sphinx-basic/blob/main/docs/requirements.in>`_
11+
Python dependencies are `pinned <https://docs.readthedocs.io/en/latest/guides/reproducible-builds.html>`_ (uses `pip-tools <https://pip-tools.readthedocs.io/en/latest/>`_)
12+
💡 `lumache.py <https://github.com/readthedocs-examples/example-sphinx-basic/blob/main/lumache.py>`_
13+
Auto-generated API docs for an example Python module, uses your *docstrings* directly in documentation
14+
🔢 Git tags versioning
15+
A basic versioning mechanism with git tags.
16+
📜 `README.rst <https://github.com/readthedocs-examples/example-sphinx-basic/blob/main/README.rst>`_
17+
Contents of this ``README.rst`` are visible on Github and included on `the documentation index page <https://example-sphinx-basic.readthedocs.io/en/latest/>`_ (Don't Repeat Yourself)
18+
⁉️ Questions / comments
19+
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-sphinx-basic/issues>`_.
1420

1521

1622
Sphinx Example Project usage
@@ -27,7 +33,9 @@ You can build and view this documentation project locally - you may want to acti
2733
2834
# Enter the Sphinx project
2935
cd docs/
30-
make html
36+
37+
# Run the raw sphinx-build command
38+
sphinx-build -M html . _build/
3139
3240
3341
You can also build the documentation locally with ``make``:
@@ -40,7 +48,7 @@ You can also build the documentation locally with ``make``:
4048
# Build with make
4149
make html
4250
43-
# Open with your preferred browser
51+
# Open with your preferred browser, pointing it to the documentation index page
4452
firefox _build/html/index.html
4553
4654

0 commit comments

Comments
 (0)