Скрыть определенные файлы из toctree
Я использую экземпляр readthedocs.org на своем локальном хосте для создания HTML-документации из моего репозитория github, и я хотел бы иметь возможность сделать следующее.
В настоящее время у меня есть список файлов, которые читаются с помощью функции глобуса toctree, например:
.. toctree::
:maxdepth: 2
:glob:
*
Но мне нужно избегать определенных файлов, которые будут перечислены в моем токе, например:
Test_Manuals.rst
Test_Process.rst
Test_Users.rst
Testing.rst <--- Only this file should appear in the toctree, all others are listed inside this one
Testing_on_test_dot_spy.rst
Я попытался добавить: hidden: под разделом: glob: но он просто скрывает все.
Я изучил столько документации, сколько смог найти, но нигде не нашел примера, когда эти два варианта используются вместе.
Есть идеи как этого добиться? Спасибо.
1 ответ
Я относительно новичок в Sphinx, так что, возможно, это ужасный Sphinx-этикет, но я обнаружил, что это дало желаемое поведение без каких-либо предупреждений:
.. toctree::
:glob:
dir_to_glob/*
.. toctree::
:hidden:
dir_to_glob/file_to_hide
Бросать в секунду toctree
кажется, переписать, как справиться file_to_hide
не портя ничего в мире. Таким образом, вам нужно только вести список "исключить" (который для меня мал, и звучит так же, как и для вашего случая).