Wyłączanie pojedynczych komunikatów ostrzegawczych dotyczących Sphinx

Question

Mam wiele plików .rst w moim drzewie Sfinksa, które celowo są wykluczane z dowolnego drzewa indeksu. Otrzymuję ostrzeżenia takie jak:

/filename.rst:: WARNING: document isn't included in any toctree 

Jak mogę ukryć określone ostrzeżenia w Sfinksie?

Answer 1

1. Czy w twoim projekcie Sphinx znajdują się pliki .rst, których zawartości nie chcesz na wyjściu?

   Użyj zmiennej konfiguracyjnej exclude_patterns. Żadne wyjście (i brak komunikatów ostrzegawczych) nie zostanie wygenerowane dla plików pasujących do określonych wzorców. Zobacz http://sphinx-doc.org/config.html#confval-exclude_patterns.

2. Czy w twoim projekcie Sphinx znajdują się pliki .rst, które nie są częścią żadnego drzewa TOCTree, ale których zawartość powinna być na wyjściu?

   Dodaj :orphan: u góry każdego pliku .rst, aby wyłączyć komunikat ostrzegawczy. Zobacz http://sphinx-doc.org/markup/misc.html#file-wide-metadata.