You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.rst
+20-12Lines changed: 20 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,22 @@
1
1
Example: Basic Sphinx project for Read the Docs
2
2
===============================================
3
3
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.
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>`_.
14
20
15
21
16
22
Sphinx Example Project usage
@@ -27,7 +33,9 @@ You can build and view this documentation project locally - you may want to acti
27
33
28
34
# Enter the Sphinx project
29
35
cd docs/
30
-
make html
36
+
37
+
# Run the raw sphinx-build command
38
+
sphinx-build -M html . _build/
31
39
32
40
33
41
You can also build the documentation locally with ``make``:
@@ -40,7 +48,7 @@ You can also build the documentation locally with ``make``:
40
48
# Build with make
41
49
make html
42
50
43
-
# Open with your preferred browser
51
+
# Open with your preferred browser, pointing it to the documentation index page
0 commit comments