IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Add text representation of the document structure

Browse Source
This commit is contained in:
Juan Luis Cano Rodríguez 2021-06-21 08:09:26 +02:00
parent 0581a17ca6
commit 35714269e8
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/tutorial/index.rst
View File

@ -364,10 +364,16 @@ the end of ``index.rst`` including the document you just created, as follows:
usage usage
This step inserts that document in the root of the *toctree*, so now it belongs 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 to the structure of your project, which so far looks like this:
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 .. code-block:: text
just created. Neat!
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:: .. warning::