diff options
Diffstat (limited to 'doc/tutorial')
| -rw-r--r-- | doc/tutorial/automatic-doc-generation.rst | 2 | ||||
| -rw-r--r-- | doc/tutorial/deploying.rst | 2 | ||||
| -rw-r--r-- | doc/tutorial/describing-code.rst | 2 | ||||
| -rw-r--r-- | doc/tutorial/index.rst | 5 | ||||
| -rw-r--r-- | doc/tutorial/narrative-documentation.rst | 2 |
5 files changed, 6 insertions, 7 deletions
diff --git a/doc/tutorial/automatic-doc-generation.rst b/doc/tutorial/automatic-doc-generation.rst index 8d9c9c9..db880d0 100644 --- a/doc/tutorial/automatic-doc-generation.rst +++ b/doc/tutorial/automatic-doc-generation.rst @@ -142,7 +142,7 @@ contain two new pages: - ``api.html``, corresponding to ``docs/source/api.rst`` and containing a table with the objects you included in the ``autosummary`` directive (in this case, only one). -- ``generated/lumache.html``, corresponding to a newly created reST file +- ``generated/lumache.html``, corresponding to a newly created reStructuredText file ``generated/lumache.rst`` and containing a summary of members of the module, in this case one function and one exception. diff --git a/doc/tutorial/deploying.rst b/doc/tutorial/deploying.rst index 6b7913f..c269593 100644 --- a/doc/tutorial/deploying.rst +++ b/doc/tutorial/deploying.rst @@ -159,7 +159,7 @@ way of getting started is to follow :doc:`the RTD tutorial <readthedocs:tutorial/index>`, which is loosely based on this one. You can publish your sources on GitHub as explained :ref:`in the previous section <publishing-sources>`, then skip directly to -:ref:`readthedocs:tutorial/index:Sign up for Read the Docs`. +:ref:`readthedocs:tutorial/index:Creating a Read the Docs account`. If you choose GitLab instead, the process is similar. GitHub Pages diff --git a/doc/tutorial/describing-code.rst b/doc/tutorial/describing-code.rst index 16feb2a..e8c6a80 100644 --- a/doc/tutorial/describing-code.rst +++ b/doc/tutorial/describing-code.rst @@ -75,7 +75,7 @@ Cross-referencing Python objects By default, most of these directives generate entities that can be cross-referenced from any part of the documentation by using -:ref:`a corresponding role <python-roles>`. For the case of functions, +:ref:`a corresponding role <python-xref-roles>`. For the case of functions, you can use :rst:role:`py:func` for that, as follows: .. code-block:: rst diff --git a/doc/tutorial/index.rst b/doc/tutorial/index.rst index d7f4861..54f4c72 100644 --- a/doc/tutorial/index.rst +++ b/doc/tutorial/index.rst @@ -1,8 +1,7 @@ .. _tutorial: -================================== -Tutorial: Build your first project -================================== +Build your first project +======================== In this tutorial you will build a simple documentation project using Sphinx, and view it in your browser as HTML. The project will include narrative, diff --git a/doc/tutorial/narrative-documentation.rst b/doc/tutorial/narrative-documentation.rst index a81204d..0c41392 100644 --- a/doc/tutorial/narrative-documentation.rst +++ b/doc/tutorial/narrative-documentation.rst @@ -85,7 +85,7 @@ introduction paragraph in ``index.rst``: Check out the :doc:`usage` section for further information. -The :rst:role:`doc` :ref:`role <rst-roles-alt>` you used automatically +The :rst:role:`doc` :ref:`role <rst-roles>` you used automatically references a specific document in the project, in this case the ``usage.rst`` you created earlier. |