diff options
| author | Juan Luis Cano RodrÃguez <hello@juanlu.space> | 2021-06-21 07:46:13 +0200 |
|---|---|---|
| committer | Juan Luis Cano RodrÃguez <hello@juanlu.space> | 2021-06-21 07:46:13 +0200 |
| commit | 8377a550a27a22b1a292fe33a22e1a32a95fe5e1 (patch) | |
| tree | 85afb8fcf08100468a2756b28360108e512bfe89 /doc/tutorial | |
| parent | 3fcaa172db8eccdd97c01a49102f7a95124fbbcf (diff) | |
| download | sphinx-git-8377a550a27a22b1a292fe33a22e1a32a95fe5e1.tar.gz | |
Simplify out-of-toctree warning
Diffstat (limited to 'doc/tutorial')
| -rw-r--r-- | doc/tutorial/index.rst | 8 |
1 files changed, 3 insertions, 5 deletions
diff --git a/doc/tutorial/index.rst b/doc/tutorial/index.rst index fe3eaf045..f42bbee0c 100644 --- a/doc/tutorial/index.rst +++ b/doc/tutorial/index.rst @@ -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 ~~~~~~~~~~~~~~~~~~~~~~~ |