Как заставить sphinx игнорировать директиву include при сборке документации? - PullRequest
0 голосов
/ 27 мая 2019

Я запускаю команду sphinx-build из командной строки для создания документации по латексу и html, поскольку они имеют одинаковые исходные файлы .rst:

$ sphinx-build -b html <source> <output>

$ sphinx-build -b latex <source> <output>

Однако для вывода из латекса я хочу игнорировать все директивы include.

Это можно сделать, добавив файл documenttils.conf в тот же каталог, что и conf.py sphinx со следующим содержимым:

[parsers]
[restructuredtext parser]
file-insertion-enabled:false

Это частичное решение, так как мне приходится менять содержимое (false или true) файла documenttils.conf каждый раз, когда я запускаю sphinx-build для вывода html и latex.

Можно сказать sphinx игнорировать директиву include, не полагаясь на файл documentstils.conf, указав, что я хочу no-file-insertion при запуске команды sphinx-build?

1 Ответ

0 голосов
/ 29 мая 2019

После некоторого времени поиска я нашел директиву sphinx, которая включает его содержимое только тогда, когда выражение истинно (директива only):

.. only:: html

    .. include:: <path/to/file.rst>

Это было простое решение, которое отлично работает для меня;содержимое file.rst включено только при создании HTML-документации, а не при создании латексных файлов.

Спасибо!

...