homepage

This issue tracker has been migrated to GitHub , and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Misleading 'toctree references unknown document' error
Type: Stage:
Components: Documentation tools (Sphinx) Versions:
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: georg.brandl Nosy List: georg.brandl, henryl
Priority: normal Keywords: patch

Created on 2008年04月08日 02:11 by henryl, last changed 2022年04月11日 14:56 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
unknown_reference.patch henryl, 2008年04月08日 02:11 Patch to include quotes in 'unknown document' errors
Messages (2)
msg65134 - (view) Author: Henry (henryl) Date: 2008年04月08日 02:11
The 'toctree references unknown document' can be misleading when the
document name includes whitespace.
For example, I had mistakenly created an index file of the form
.. toctree::
 :maxdepth: 2
 overview
(note that overview has a leading space). In the error message is was
very difficult to see that this was a problem, as the error message was
WARNING: /home/henry/code/bdec.docs/doc/source/index.rst:8: (WARNING/2)
toctree references unknown document overview
By putting the document name in quotes, it becomes clearer what the
problem was.
WARNING: /home/henry/code/bdec.docs/doc/source/index.rst:8: (WARNING/2)
toctree references unknown document ' overview'
A patch to include these quotes has been attached.
msg65245 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2008年04月09日 17:50
Thanks, fixed in r62245.
History
Date User Action Args
2022年04月11日 14:56:33adminsetgithub: 46831
2008年04月09日 17:50:33georg.brandlsetstatus: open -> closed
resolution: fixed
messages: + msg65245
2008年04月08日 02:11:34henrylcreate

AltStyle によって変換されたページ (->オリジナル) /