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

Simplify out-of-toctree warning

Browse Source
This commit is contained in:
Juan Luis Cano Rodríguez
2021-06-21 07:46:13 +02:00
parent 3fcaa172db
commit 8377a550a2
1 changed files with 3 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
doc/tutorial/index.rst
View File

@@ -371,11 +371,9 @@ just created. Neat!
.. warning::
Every document should belong to a *toctree*. Otherwise, Sphinx will emit a
``WARNING: document isn't included in any toctree``, and the end result
will depend on the builder. For the HTML builder, the page will not be
linked from anywhere (therefore it will not be discoverable), whereas for
the PDF builder, it will not be included at all.
Documents outside a *toctree* will result in ``WARNING: document isn't
included in any toctree`` messages during the build process, and will be
unreachable for users.
Adding cross-references
~~~~~~~~~~~~~~~~~~~~~~~