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.

Author henryl
Recipients georg.brandl, henryl
Date 2008-04-08.02:11:33
SpamBayes Score 0.17714542
Marked as misclassified No
Message-id <1207620696.06.0.199132876602.issue2579@psf.upfronthosting.co.za>
In-reply-to
Content
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.
History
Date User Action Args
2008-04-08 02:11:36henrylsetspambayes_score: 0.177145 -> 0.17714542
recipients: + henryl, georg.brandl
2008-04-08 02:11:36henrylsetspambayes_score: 0.177145 -> 0.177145
messageid: <1207620696.06.0.199132876602.issue2579@psf.upfronthosting.co.za>
2008-04-08 02:11:34henryllinkissue2579 messages
2008-04-08 02:11:34henrylcreate