LINUX.ORG.RU

Sphinx Python Отключить исполнение кода


0

1

Решил использовать для автодокументирования сфинк. http://sphinx.pocoo.org/ И всё бы отлично, но есть такое дело, что сфинк исполняет исходный код. В большинстве случаев, это не проблема, но когда он пытается документировать какого-нибудь демона, то просто повисает, либо запускает демона и игнорирует исходный код оного. И второй случай, это когда сфинкс не может симпортить что-нибудь(исходный код на Python). В данном случае исходный код модуля игнорируется, т.е. сфинкс документирует только реально рабочий код.

Использую для всего этого автодок с такими директивами

.. automodule:: loki.apps.document.models
    :members:
    :undoc-members:
    :show-inheritance:
Может я просмотрел или просто туплю, но в доках я не нашел, как отучить сфинкс исполнять исходный код. Как сделать так, чтобы сфинкс статически выдирал все каменты из кода и формировал доку без исполнения кода?


Решение очень простое. Писать код так, чтобы импорт модуля не приводил к сайдэффектам.

baverman ★★★
()
Вы не можете добавлять комментарии в эту тему. Тема перемещена в архив.