Я хочу документировать свой код с помощью 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
Sphinx-apidoc и макет 'src' ⇐ Python
Программы на Python
1766153254
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/
Подробнее здесь: [url]https://stackoverflow.com/questions/79841220/sphinx-apidoc-and-src-layout[/url]
Ответить
1 сообщение
• Страница 1 из 1
Перейти
- Кемерово-IT
- ↳ Javascript
- ↳ C#
- ↳ JAVA
- ↳ Elasticsearch aggregation
- ↳ Python
- ↳ Php
- ↳ Android
- ↳ Html
- ↳ Jquery
- ↳ C++
- ↳ IOS
- ↳ CSS
- ↳ Excel
- ↳ Linux
- ↳ Apache
- ↳ MySql
- Детский мир
- Для души
- ↳ Музыкальные инструменты даром
- ↳ Печатная продукция даром
- Внешняя красота и здоровье
- ↳ Одежда и обувь для взрослых даром
- ↳ Товары для здоровья
- ↳ Физкультура и спорт
- Техника - даром!
- ↳ Автомобилистам
- ↳ Компьютерная техника
- ↳ Плиты: газовые и электрические
- ↳ Холодильники
- ↳ Стиральные машины
- ↳ Телевизоры
- ↳ Телефоны, смартфоны, плашеты
- ↳ Швейные машинки
- ↳ Прочая электроника и техника
- ↳ Фототехника
- Ремонт и интерьер
- ↳ Стройматериалы, инструмент
- ↳ Мебель и предметы интерьера даром
- ↳ Cантехника
- Другие темы
- ↳ Разное даром
- ↳ Давай меняться!
- ↳ Отдам\возьму за копеечку
- ↳ Работа и подработка в Кемерове
- ↳ Давай с тобой поговорим...
Мобильная версия