From 35714269e86b5bea09139143849b21c45e124f70 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Luis=20Cano=20Rodr=C3=ADguez?= Date: Mon, 21 Jun 2021 08:09:26 +0200 Subject: [PATCH] Add text representation of the document structure --- doc/tutorial/index.rst | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/doc/tutorial/index.rst b/doc/tutorial/index.rst index d4a5ad97d..0657dda32 100644 --- a/doc/tutorial/index.rst +++ b/doc/tutorial/index.rst @@ -364,10 +364,16 @@ the end of ``index.rst`` including the document you just created, as follows: usage This step inserts that document in the root of the *toctree*, so now it belongs -to the structure of your project. If you export the documentation to HTML -running ``make html``, you will see that the ``toctree`` gets rendered as a -list of hyperlinks, and this allows you to navigate to the new page you -just created. Neat! +to the structure of your project, which so far looks like this: + +.. code-block:: text + + index + └── usage + +If you export the documentation to HTML running ``make html``, you will see +that the ``toctree`` gets rendered as a list of hyperlinks, and this allows you +to navigate to the new page you just created. Neat! .. warning::