diff options
Diffstat (limited to 'doc/concepts.rst')
| -rw-r--r-- | doc/concepts.rst | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/concepts.rst b/doc/concepts.rst index 379888ffc..afb9503bb 100644 --- a/doc/concepts.rst +++ b/doc/concepts.rst @@ -55,19 +55,19 @@ tables of contents. The ``toctree`` directive is the central element. ``strings`` and so forth, and it knows that they are children of the shown document, the library index. From this information it generates "next chapter", "previous chapter" and "parent chapter" links. - + Document titles in the :dir:`toctree` will be automatically read from the title of the referenced document. If that isn't what you want, you can give the specify an explicit title and target using a similar syntax to reST hyperlinks (and Sphinx's :ref:`cross-referencing syntax <xref-syntax>`). This looks like:: - + .. toctree:: - + intro All about strings <strings> datatypes - + The second line above will link to the ``strings`` document, but will use the title "All about strings" instead of the title of the ``strings`` document. @@ -97,7 +97,7 @@ tables of contents. The ``toctree`` directive is the central element. This will still notify Sphinx of the document hierarchy, but not insert links into the document at the location of the directive -- this makes sense if you intend to insert these links yourself, in a different style. - + In the end, all documents in the :term:`source directory` (or subdirectories) must occur in some ``toctree`` directive; Sphinx will emit a warning if it finds a file that is not included, because that means that this file will not |