Вопросы по теме 'autodoc'
как заставить apidocs использовать пакеты вместо модулей в sphinx-apidoc
Я использую строки документации для документирования кода Python и sphinx-autodoc для создания HTML-кодов apidoc. Структура моих пакетов следующая: mainpackage.subpackage.module , я хочу, чтобы apidocs связывались с классами из модуля как...
712 просмотров
schedule
15.10.2021
Автодок Sphinx с параметром из имитационного модуля на readthedocs
Мы используем readthedocs для документирования нашего проекта с открытым исходным кодом pandapower.
Поскольку pandapower имеет зависимости от numpy и других библиотек C, которые не могут быть построены на rtd, мы используем параметр...
413 просмотров
schedule
11.11.2021
sphinx создает пустую документацию
Предположим, следующая структура моего кода:
A/
__init__.py
B.py
Run.py
Я продолжаю и устанавливаю расширение sphinx и numpydoc. Затем я запускаю sphinx-quickstart и выбираю значение по умолчанию (не разделяйте источник...
213 просмотров
schedule
27.09.2021
Sphinx неправильно отображает документацию по коду
Проблема:
Sphinx не отображает документированный код - только оглавление. Я изолировал это до того, что Sphinx не генерирует файлы * .rst для каждого документированного файла * .py при вызове sphinx-apidoc.
Примечание.
Я использую vscode с...
123 просмотров
schedule
19.02.2022
Sphinx autodoc TypeError: объект типа не повторяется
При попытке создать документацию (любого типа: html, man-страницы, latexpdf ...) sphinx завершается ошибкой при попытке автодокументировать подкаталог проекта. Я пробовал много разных подходов, чтобы попытаться сузить круг проблем, но, похоже, не...
823 просмотров
schedule
14.03.2022
Sphinx-build генерирует ошибку для файла python, сгенерированного SWIG, при импорте модуля python
Я пытаюсь создать документацию для некоторого модуля интерфейса Python, созданного SWIG на коде C. Я использую директиву %feature(docstring) в файлах интерфейса SWIG (* .i), как упоминалось в сообщении: Sphinx и документирование Python из готового...
202 просмотров
schedule
15.03.2022
Ошибки Sphinx autodoc и OpenCV (cv2) (Python 3.7)
Во-первых, скажу, что я совершенно новичок в сфинксе. Я работаю над проектом обработки изображений, который использует opencv. Хотя мне удалось настроить sphinx (и успешно протестировать его с некоторыми простыми модулями), я изо всех сил пытаюсь...
65 просмотров
schedule
25.03.2022
Подключить Sphinx autodoc-skip-member к моей функции
Я хочу использовать событие sphinx autodoc-skip-member чтобы выбрать часть членов определенного класса Python для документации.
Но из документов sphinx это неясно, и я не могу найти примеры, которые иллюстрируют: где мне поместить код для...
6343 просмотров
schedule
02.04.2022
Получение вывода плоских элементов для автомодуля sphinx
Я использую расширение Autodoc Sphinx для документирования модуля и хочу получить плоский список членов модуля в выводе документации.
Я пробовал использовать следующее:
.. automodule:: modname
:members:
Однако здесь есть две проблемы:...
1120 просмотров
schedule
13.04.2022
Почему Sphinx не поддерживает переменные модуля autodoc?
Я хочу иметь автоматическую документацию для переменных модуля, но это просто не работает. В документе отсутствуют все переменные ... Как я могу это исправить, чтобы autodoc отображал каждую переменную модуля?
mypackage / __ init__.py :
class...
1582 просмотров
schedule
27.04.2022
Почему автокласс создает здесь псевдонимы?
Короче говоря, у меня есть код, который работает, но если я немного подправлю его, некоторые вещи развалятся, и я не могу понять, почему. Я надеюсь, что кто-то более опытный, чем я, может дать мне несколько указателей Sphinx. Я искал и не видел...
57 просмотров
schedule
03.06.2022
Пропустить (или отформатировать) значение переменной при документировании с помощью Sphinx
В настоящее время я документирую целый модуль с помощью autodoc . . Однако я определяю несколько переменных на уровне модуля, которые содержат длинные списки или словари. Они включены в документацию вместе со значениями, а значения не...
1135 просмотров
schedule
03.05.2023
Как автодокументировать функцию внутри метода в Sphinx
Пример кода:
class A(object):
def do_something(self):
""" doc_a """
def inside_function():
""" doc_b """
pass
pass
Я старался:
.. autoclass:: A
.. autofunction::...
978 просмотров
schedule
02.04.2023
Ошибка Sphinx: неизвестный тип директивы automdule или autoclass
Мне нужно задокументировать мой проект Python с помощью Sphinx. Но я не могу использовать autodoc .
Когда я настраиваю свой проект, я выбираю опцию «extension autodoc», но теперь, если я использую
.. autoclass:: Class
Я получаю сообщение...
31028 просмотров
schedule
27.08.2023
Как включить автоматически все классы, методы и функции в документацию сфинкса?
Я пытаюсь создать html-документацию для проекта, содержащего несколько тысяч классов, используя sphinx и его плагин autodoc. sphinx-apidoc создает замечательные первые файлы, но ему не хватает автоматического создания автоклассов и автометодов ....
10706 просмотров
schedule
06.05.2023
Могу ли я подавить раскрытие переменных в документации Sphinx?
В моем коде у меня есть
X_DEFAULT = ['a', 'long', 'list', 'of', 'values', 'that', 'is', 'really', 'ugly', 'to', 'see', 'over', 'and', 'over', 'again', 'every', 'time', 'it', 'is', 'referred', 'to', 'in', 'the', 'documentation']
и позже...
760 просмотров
schedule
10.04.2023
В Python Sphinx есть ли способ скрыть код установки autodoc?
Я использую Sphinx autodoc для документирования своего кода Python. Примеры в моей документации содержат:
Неинтересный код настройки, который я не хочу отображать в HTML-документации
Код, который должен появиться в документации
Например:...
303 просмотров
schedule
08.08.2023
Как остановить префикс имени метода автоматического метода Sphinx с именем класса
Когда я использую автоматический метод Sphinx для документирования определенного метода, например:
.. automethod:: my_module.MyClass.my_method
Полученные документы добавляют имя класса к имени метода следующим образом:...
1246 просмотров
schedule
05.07.2023
Разрывы перекрестных ссылок Sphinx для унаследованных объектов, импортированных и задокументированных в родительском модуле
Я пытаюсь правильно собрать мою документацию по Sphinx, и чтобы перекрестные ссылки (в том числе из унаследованных отношений) работали правильно.
В моем проекте у меня есть ситуация, изображенная в приведенном ниже примере, которую я воспроизвел...
776 просмотров
schedule
21.02.2023
Readthedocs: Есть ли способ автодокументировать функции одной и той же модели отдельно в одном файле?
Прямо сейчас у моих docs / source есть index.rst , который в своей доктрине импортирует другой файл с именем api.rst . В этом api.rst файле я хотел бы autodoc модуль Python. Этот модуль представляет собой .py со многими функциями, не...
163 просмотров
schedule
02.11.2022
