summaryrefslogtreecommitdiff
path: root/doc/tutorial
diff options
context:
space:
mode:
authorJuan Luis Cano Rodríguez <hello@juanlu.space>2021-09-06 17:11:39 +0200
committerJuan Luis Cano Rodríguez <hello@juanlu.space>2021-09-06 17:14:31 +0200
commit2755333437b69dc1b3c98845a3fe3116e3b81728 (patch)
tree7ad093d8e82469f0e02d2c39b994a4b37da4cf29 /doc/tutorial
parent32f2f909acd8843f50a430ad11f2ac9dfd879373 (diff)
downloadsphinx-git-2755333437b69dc1b3c98845a3fe3116e3b81728.tar.gz
Add connections to the next sections
Diffstat (limited to 'doc/tutorial')
-rw-r--r--doc/tutorial/describing-code.rst4
-rw-r--r--doc/tutorial/first-steps.rst3
-rw-r--r--doc/tutorial/getting-started.rst1
-rw-r--r--doc/tutorial/more-sphinx-customization.rst3
-rw-r--r--doc/tutorial/narrative-documentation.rst3
5 files changed, 13 insertions, 1 deletions
diff --git a/doc/tutorial/describing-code.rst b/doc/tutorial/describing-code.rst
index 6bb18b342..6a7128701 100644
--- a/doc/tutorial/describing-code.rst
+++ b/doc/tutorial/describing-code.rst
@@ -220,3 +220,7 @@ for easy examination. It is now time to fix the function:
return ["shells", "gorgonzola", "parsley"]
And finally, ``make test`` reports success!
+
+For big projects though, this manual approach can become a bit tedious.
+In the next section, you will see :doc:`how to automate the
+process </tutorial/automatic-doc-generation>`.
diff --git a/doc/tutorial/first-steps.rst b/doc/tutorial/first-steps.rst
index 791ee38f5..fd5c63135 100644
--- a/doc/tutorial/first-steps.rst
+++ b/doc/tutorial/first-steps.rst
@@ -79,7 +79,8 @@ behavior by adding the following code at the end of your ``conf.py``:
With this configuration value, and after running ``make epub`` again, you will
notice that URLs appear now as footnotes, which avoids cluttering the text.
-Sweet!
+Sweet! Read on to explore :doc:`other ways to customize
+Sphinx </tutorial/more-sphinx-customization>`.
.. note::
diff --git a/doc/tutorial/getting-started.rst b/doc/tutorial/getting-started.rst
index ccfa0952e..5cf0b38aa 100644
--- a/doc/tutorial/getting-started.rst
+++ b/doc/tutorial/getting-started.rst
@@ -117,3 +117,4 @@ something like this:
Freshly created documentation of Lumache
There we go! You created your first HTML documentation using Sphinx.
+Now you can start :doc:`customizing it </tutorial/first-steps>`.
diff --git a/doc/tutorial/more-sphinx-customization.rst b/doc/tutorial/more-sphinx-customization.rst
index 6a35a6c8c..c28263c26 100644
--- a/doc/tutorial/more-sphinx-customization.rst
+++ b/doc/tutorial/more-sphinx-customization.rst
@@ -73,3 +73,6 @@ appearance:
:alt: HTML documentation of Lumache with the Furo theme
HTML documentation of Lumache with the Furo theme
+
+It is now time to :doc:`expand the narrative documentation and split it into
+several documents </tutorial/narrative-documentation>`.
diff --git a/doc/tutorial/narrative-documentation.rst b/doc/tutorial/narrative-documentation.rst
index adef47649..b1f23b0ff 100644
--- a/doc/tutorial/narrative-documentation.rst
+++ b/doc/tutorial/narrative-documentation.rst
@@ -127,3 +127,6 @@ cross-reference to. If you do not include an explicit title, hence using
``:ref:`installation```, the section title will be used (in this case,
``Installation``). Both the ``:doc:`` and the ``:ref:`` roles will be rendered
as hyperlinks in the HTML documentation.
+
+What about :doc:`documenting code objects in Sphinx </tutorial/describing-code>`?
+Read on!