Вопросы по теме 'numpydoc'

Sphinx Autodoc и NumpyDoc
несмотря на то, что прочитал это руководство , этот вопрос и стандарт numpy docstring , я не могу заставить sphinx autodoc хорошо работать с numpy docstrings. В моем conf.py есть: extensions = ['sphinx.ext.autodoc', 'numpydoc'] и в...
3890 просмотров
schedule 29.03.2022

autosummary «toctree содержит ссылку на несуществующий документ» предупреждения
Я столкнулся с той же проблемой, что и в этой ветке . Когда я создаю документацию Sphinx с помощью make html , я получаю много подобных предупреждений. None:None: WARNING: toctree contains reference to nonexisting document...
2258 просмотров
schedule 26.06.2022

Можно ли иметь список параметров в sphinx.ext.napoleon?
Я использую расширение sphinx autodoc вместе с sphinx.ext.napoleon. Я следую руководству по стилю numpydoc, так как считаю его более читабельным, чем у Google. Однако я заметил следующую проблему, которую не смог исправить. У меня следующий...
1821 просмотров
schedule 21.06.2023

Получите автосводку для создания плоского представления
Если у меня есть файл foo.baz.py : from foo.bar.baz import Quux, Quuux __all__ = ['Quux', 'Quuux'] Я хотел бы задокументировать api следующим образом: Baz === .. currentmodule:: foo.baz .. autosummary:: :toctree: generated/...
14 просмотров
schedule 16.01.2023