Is it possible to suppress "document isn't included in any toctree" warnings?

[Libor Jelínek]

Ideally for specified documents only.

Closest is "suppress_warnings" setting but it doesn't what I ask.

Thanks

Libor

[Gert van Dijk]

On Thu, May 16, 2019 at 8:04 PM Libor Jelínek <ljel...@virtage.com> wrote:

Ideally for specified documents only.

Closest is "suppress_warnings" setting but it doesn't what I ask.

Looking at the code, it skips the warning if the document is marked as 'orphan', which appears to be marked as such with a directive like this at the top of the RST file:

:orphan:

Tried it out and seems to work for me. :-)

Also documented as such: https://www.sphinx-doc.org/en/2.0/usage/restructuredtext/field-lists.html#metadata

HTH

[Stefano David]

Hi,

This seems not to work (as I would expect) if the "orphaned" foo.rst file is included in bar.rst file. In this case, while it suppresses the "not included" warning, it emits a warning about duplicated labels (which are written in the foo.rst file).

An alternative solution would be to put foo.rst (with path) in the exclude_patterns list of conf.py.

My 2 cents,

Stefano

HTH

[Paul Everitt]

You can make a second toctree marked as hidden and put your orphans in there.