Включить произвольные файлы в RST - PullRequest
0 голосов
/ 30 апреля 2020

Директива DocUtils include позволяет включать произвольный текст в документ RST. Проблема заключается в том, что реализация ограничивает указанные файлы тем же документом, что и местоположение включенного файла. Это затрудняет использование включений для внешних файлов, которые могут использоваться во многих документах. Стандартное решение DocUtils состоит в том, чтобы использовать то, что называется Standard Definition Files. К сожалению, для этого требуется, чтобы кто-либо, использующий эту возможность, имел исходный код DocUtils, который затронет каждого конечного пользователя, которому нужна эта возможность. Необходимый исходный код не является приемлемым решением для людей, которые не являются программистами и только пытаются использовать Docutils, возможно, в такой среде, как Sphinx. Есть ли другой выход из этой ситуации?

1 Ответ

0 голосов
/ 30 апреля 2020

Используйте директиву literalinclude , используя .. для перемещения вверх и вокруг файловой системы. Например:

.. literalinclude:: ../../external-to-project-directory/src/somefile.py

Включит somefile.py в качестве буквального кода в вашу документацию.

Если вы хотите проанализировать код как первый, используйте include вместо.

...