Sphinx генерирует документацию на основе двух отдельных sys.path.Python

Программы на Python
Ответить
Anonymous
 Sphinx генерирует документацию на основе двух отдельных sys.path.

Сообщение Anonymous »

У меня есть следующая структура, которую нужно отобразить в качестве документации
index.rst:

Код: Выделить всё

.. toctree::
:maxdepth: 2
:caption: Feature Family

feature/modules.rst

.. toctree::
:maxdepth: 2
:caption: Extract

extract/modules.rst

feature/modules.rst:

Код: Выделить всё

feature
=======

.. toctree::
:maxdepth: 3

app_package
call_logs
contact_list
sms_logs
user

extract/modules.rst:

Код: Выделить всё

extract
=======

.. toctree::
:maxdepth: 3

app_packages
call_logs
contact_list
sms_logs
user
users

Теперь Feature/modules.rst и Extract/modules.rst имеют общие имена папок подкатегорий:

Код: Выделить всё

call_logs, contact_list, sms_logs , user 
, поэтому sphinx путается с тем, какой sys.path использовать при создании соответствующей документации. В настоящее время мой conf.py имеет следующие определения:

Код: Выделить всё

sys.path.insert(0, os.path.abspath('..'))
sys.path.insert(0, os.path.abspath('../..'))
sys.path.insert(0, os.path.abspath('../../feature_service/feature'))
sys.path.insert(0, os.path.abspath('../../feature_service/extract'))
Только если бы я удалил ../../feature_service/extract из sys.path, тогда документация из ../../feature_service/feature будет сгенерировано правильно, потому что имена подпапок в этих категориях совпадают. Я подозреваю, что sphinx не понимает, в каком каталоге искать при использовании autodoc Есть ли обходной путь для этого? Изменение названий папок на другие будет работать, но не рекомендуется

Подробнее здесь: https://stackoverflow.com/questions/792 ... e-sys-path
Ответить

Быстрый ответ

Изменение регистра текста: 
Смайлики
:) :( :oops: :roll: :wink: :muza: :clever: :sorry: :angel: :read: *x)
Ещё смайлики…
   
К этому ответу прикреплено по крайней мере одно вложение.

Если вы не хотите добавлять вложения, оставьте поля пустыми.

Максимально разрешённый размер вложения: 15 МБ.

Вернуться в «Python»