Skip to content

Commit

Permalink
[TASK] Apply suggestions from code review
Browse files Browse the repository at this point in the history
  • Loading branch information
linawolf committed Jan 24, 2024
1 parent 9e64290 commit 6be6c7c
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions Documentation/GeneralConventions/FileStructure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -88,16 +88,16 @@ document title. This way you can link to a documents start page by:
If your manual has more pages then this one it must contain a table of content
directive called :rst:`.. toctree::`. The `toctree` on the start page
defines which pages will be displayed in the menu on the left of the rendered
defines which pages will be displayed in main navigation of the rendered
manual.

.. _index-rst-table-of-contents:

Configure the menu - the toctree
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The `toctree` on the startpage can be hidden, it then only influences the menu
on the left:
The `toctree` on the startpage can be hidden, it then only influences the main
navigation:

.. code-block:: rst
Expand Down Expand Up @@ -126,15 +126,15 @@ Or it can be inserted visibly into the start page to provide an entry point:
For large pages it is advisable to limit the number of menu levels that will
be displayed on the startpage by setting :rest:`:maxdepth:`. This will not
limit the level of pages displayed in the menu on the left.
limit the level of pages displayed in the main navigation.

For more information on possible options on the `toctree` directive see
chapter :ref:`Toctrees in the reST reference <toctree>`.

It is possible to use more then one `toctree` directives on the start page.
It is possible to use more then one `toctree` directive on the start page.
Each `toctree` should have a :rst:`:caption:` in this case.

The menu on the left will then be divided into sections labeled by those
The main navigation will then be divided into sections labeled by those
captions. The menu of the manual you are currently reading is an example for
that:

Expand Down

0 comments on commit 6be6c7c

Please sign in to comment.