autodoc

1зной

1ответ

sphinx-apidoc подбирает подмодули, но autodoc не документирует их

Я работаю над проектом для PyQt5 (найдено здесь: https://github.com/MaVCArt/StyledPyQt5), который использует структуру пакета, чтобы сделать импорт более логичным. Я довольно успешно документировал ко

1зной

1ответ

Как сделать apidocs использовать пакеты вместо модулей в sphinx-apidoc

Я использую docstrings для документирования кода python и sphinx-autodoc для генерации HTML-кода apidoc. Структура моих пакетов выглядит следующим образом: mainpackage.subpackage.module, я хочу, чтобы

0зной

1ответ

Mocking subodules in python

Я пытаюсь создать автодокументацию моего проекта через сфинкс. Тем не менее, я запустил генерацию автодоков в среде, в которой не будет всех модулей, которые я импортирую. Поэтому я хотел бы высмеять

4зной

1ответ

Sphinx-doc TOC не обновляется с темой RTD

У меня есть программно сгенерированный источник sphinx-doc, который использует тему Read-The-Docs. Дерево источника выглядит следующим образом: source ├── conf.py ├── index.rst ├── models │ ├──

0зной

1ответ

Autodoc Sphinx с ошибкой django

Я получаю сообщение об ошибке, когда пытаюсь создать html с autodoc. Вот моя структура проекта: projet --- app1 ------ models.py ------ views.py --- app2 --- app3 docs --- modules ------ model

1зной

1ответ

Autosummary with toctree не создает документацию для методов

Я использую sphinx с расширением numpydoc и autosummary. После некоторых экспериментов я добавил следующие параметры в файл conf.py. autosummary_generate = True numpydoc_show_class_members = False

1зной

1ответ

Sphinx не работает при создании документации для проекта Django

Я пытаюсь автоматически генерировать документацию для моего проекта Django, используя Sphinx с расширениями autodoc и napoleon. Использование sphinx-quickstart Я создал следующую структуру: MyDjangoPr