Sphinx-apidoc и макет 'src'Python

Программы на Python
Ответить
Anonymous
 Sphinx-apidoc и макет 'src'

Сообщение Anonymous »

Я хочу документировать свой код с помощью sphinx, но для своей структуры я использую макет «src». Ниже приведен пример:
products
├── src
│   └── products
│   ├── agreport.py
│   ├── cci.py
│   ├── climograph.py
│   ├── cropreport.py
│   ├── degreedays.py
│   ├── heatindex.py
│   ├── __init__.py
│   ├── penmanet.py
│   ├── precipsummary.py
│   ├── productfactory.py
│   ├── temperaturesummary.py
│   ├── windchill.py
│   └── windrose.py

Первый файл содержит минимум:
Products module
===============

.. automodule:: products
:members:
:undoc-members:
:show-inheritance:

Вызов apidocs для создания документации класса не работает. Он создает документацию, которая находится в __init__, но не в других файлах в каталоге.
sphinx-apidoc --implicit-namespaces --force -o docs/ ../products/


Подробнее здесь: https://stackoverflow.com/questions/798 ... src-layout
Ответить

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

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

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

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

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