Sign Up to our social questions and Answers Engine to ask questions, answer people’s questions, and connect with other people.
Login to our social questions & Answers Engine to ask questions answer people’s questions & connect with other people.
Lost your password? Please enter your email address. You will receive a link and will create a new password via email.
Please briefly explain why you feel this question should be reported.
Please briefly explain why you feel this answer should be reported.
Please briefly explain why you feel this user should be reported.
I have many .rst files in my Sphinx tree which are intentionally excluded from any index tree. I get warnings like
/filename.rst:: WARNING: document isn't included in any toctree
How can I suppress specific warnings in Sphinx?
Are there .rst files in your Sphinx project whose content you don’t want in the output?
Use the
exclude_patternsconfiguration variable. No output (and no warning messages) will be generated for files matching the specified patterns. See http://www.sphinx-doc.org/en/master/usage/configuration.html#confval-exclude_patterns.Are there .rst files in your Sphinx project that are not part of any toctree but whose content should be in the output?
Add
:orphan:at the top of each .rst file to suppress the warning message. See http://www.sphinx-doc.org/en/master/usage/restructuredtext/field-lists.html#file-wide-metadatayou can also use https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-suppress_warnings