diff options
| author | Juan Luis Cano RodrÃguez <hello@juanlu.space> | 2021-07-05 09:25:05 +0200 |
|---|---|---|
| committer | Juan Luis Cano RodrÃguez <hello@juanlu.space> | 2021-07-05 09:25:05 +0200 |
| commit | f303a4a9ed9196cd767f127aff292d9bcfd28514 (patch) | |
| tree | 58506ce5f91dce4ca9643f54b3f927e08e5be912 /doc/tutorial | |
| parent | 50bd1c3967fae76e36a5b1d386e3cbad637f6da1 (diff) | |
| download | sphinx-git-f303a4a9ed9196cd767f127aff292d9bcfd28514.tar.gz | |
Consistent use of "rst" for syntax highlight
Diffstat (limited to 'doc/tutorial')
| -rw-r--r-- | doc/tutorial/index.rst | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/doc/tutorial/index.rst b/doc/tutorial/index.rst index 7a7a310c3..12ae10e11 100644 --- a/doc/tutorial/index.rst +++ b/doc/tutorial/index.rst @@ -36,7 +36,7 @@ Setting up your project and development environment In a new directory, create a file called ``README.rst`` with the following content. -.. code-block:: rest +.. code-block:: rst :caption: README.rst Lumache @@ -159,7 +159,7 @@ is written in reStructuredText, a powerful markup language. Modify the file as follows: -.. code-block:: rest +.. code-block:: rst :caption: docs/source/index.rst Welcome to Lumache's documentation! @@ -330,7 +330,7 @@ grows. As an example, create a new file ``docs/source/usage.rst`` (next to ``index.rst``) with these contents: -.. code-block:: rest +.. code-block:: rst :caption: docs/source/usage.rst Usage @@ -358,7 +358,7 @@ be a *subsection* of "Usage". To complete the process, add a ``toctree`` :ref:`directive <rst-directives>` at the end of ``index.rst`` including the document you just created, as follows: -.. code-block:: rest +.. code-block:: rst :caption: docs/source/index.rst Contents @@ -397,7 +397,7 @@ them! To add a cross-reference, write this sentence right after the introduction paragraph in ``index.rst``: -.. code-block:: rest +.. code-block:: rst :caption: docs/source/index.rst Check out the :doc:`usage` section for further information. @@ -412,7 +412,7 @@ explicit *label* that can act as a target. For example, to reference the "Installation" subsection, add a label right before the heading, as follows: -.. code-block:: rest +.. code-block:: rst :caption: docs/source/usage.rst :emphasize-lines: 4 @@ -428,7 +428,7 @@ before the heading, as follows: And make the sentence you added in ``index.rst`` look like this: -.. code-block:: rest +.. code-block:: rst :caption: docs/source/index.rst Check out the :doc:`usage` section for further information, including how to |