Вопросы по теме 'autodoc'
Можно ли переопределить автодок Sphinx для определенных функций?
Я использую плагин Autodoc Sphinx для автоматического документирования набора модулей. У меня есть функция, которая принимает *args , и я хотел бы переопределить документацию, чтобы показать немного более приятный стиль funcname(arg1[, arg2[,...
7445 просмотров
schedule
15.08.2022
Как исключить банки из проекта leiningen?
При использовании Leiningen возникла следующая резкая ошибка:
Исключение в потоке "main" java.lang.NoSuchMethodError: org.apache.tools.ant.util.FileUtils.getFileUtils () Lorg / apache / tools / ant / util / FileUtils; (core.clj: 1)
Я нашел...
6051 просмотров
schedule
21.02.2023
Ошибка sphinx-build - autodoc не может импортировать / найти модуль
Я пытаюсь начать работать со Sphinx, но у меня постоянные проблемы.
Команда: docs/sphinx-quickstart
Отвечаю на все вопросы и все работает нормально.
Команда: docs/ls
Все нормально выглядит. Результат: build Makefile source...
103214 просмотров
schedule
13.05.2022
Сбой autodoc на django ImageField
Я пытаюсь использовать sphinx для документирования приложения django , которое я пишу. На данный момент у меня есть настройка code.rst для просмотра models.py , и когда я запускаю make html , я получаю автоматическую документацию, однако получаю...
404 просмотров
schedule
07.08.2023
Sphinx Autodoc и NumpyDoc
несмотря на то, что прочитал это руководство , этот вопрос и стандарт numpy docstring , я не могу заставить sphinx autodoc хорошо работать с numpy docstrings.
В моем conf.py есть:
extensions = ['sphinx.ext.autodoc', 'numpydoc']
и в...
3890 просмотров
schedule
29.03.2022
autodoc класс, который расширяет фиктивный класс
Я пытаюсь запустить autodoc для класса, который расширяет внешний класс.
Я использовал макет, чтобы импорт был принят.
Для этого я использовал то, что было описано в этом блоге...
446 просмотров
schedule
30.03.2022
Есть ли способ предварительно собрать файлы .rst, сгенерированные autodoc, в Sphinx
У меня есть проект, для которого я создал набор файлов .rst с sphinx.ext.apidoc , который извлекает документацию из строк документации моего проекта.
Эти файлы выглядят следующим образом:
Submodules
----------
.. toctree::...
385 просмотров
schedule
14.02.2023
Как я могу показать унаследованные члены класса в моей документации по Sphinx?
Я хочу задокументировать некоторые классы, которые являются производными от одного и того же базового класса с некоторыми общими атрибутами, и я хотел бы повторить документацию для каждого атрибута в подклассах, чтобы я мог видеть все атрибуты для...
5679 просмотров
schedule
04.07.2023
сделать пакеты, установленные в virtualenv, видимыми для sphinx
Я использую sphinx для документирования своего программного обеспечения. и я использую virtualenv для установки. теперь некоторые пакеты устанавливаются только в виртуальную среду, и sphinx их не видит.
У меня есть этот код в моем conf.py :...
769 просмотров
schedule
10.04.2023
Как исключить функции pytest test_* из автодока Sphinx?
У меня есть несколько модулей в моем файле package .
package/
|--mod1.py
|--mod2.py
Каждый модуль содержит несколько functions и test_function для тестирования модуля.
Я использую sphinx-apidoc для создания файлов .rst для каждого...
2733 просмотров
schedule
23.12.2022
Список словарей в документации с Sphinx
У меня есть проект с несколькими файлами .py, которые содержат только несколько словарей. Как это:
# My file
dictionary = {'key1': 'value1', 'key2: 'value2'}
Но намного больше и длиннее, и я хотел бы задокументировать это с помощью Sphinx,...
1730 просмотров
schedule
29.01.2023
sphinx autodoc для python ничего не показывает (в readthedocs)
У меня есть этот пакет python , который я хотел бы автоматически документировать с помощью Sphinx. Я вставил строки документации во все функции и классы.
Я создал учетную запись на ReadTheDocs и сделал соответствующую настройку (т.е. каталог...
1218 просмотров
schedule
27.09.2022
Автомодуль Sphinx показывает типы параметров функций. Как отключить?
Итак, я использую директиву автомодуля sphinx для создания документации модуля, в котором я передаю словарь в качестве именованного аргумента по умолчанию. Проблема в том, что он перечисляет типы всех переменных в аргументах следующим образом:...
287 просмотров
schedule
17.05.2024
Sphinx autodoc с аннотациями типа mypy
В настоящее время у меня есть код, который использует аннотации типа mypy следующим образом:
def translate(self, text, mark_unknown=False, format=None, deformat='txt', reformat='txt'):
# type: (Translator, str, bool, Optional[str], str, str)...
480 просмотров
schedule
27.11.2022
Включить __main__.py в файлы, сгенерированные sphinx-apidoc
Я не могу правильно добавить файл __main__.py и его функции при создании файла RST с помощью sphinx-apidoc . Остальные файлы и классы генерируются корректно.
Я работаю, только если запускаю sphinx-apidoc с параметром -P , который включает...
612 просмотров
schedule
17.12.2022
ПРЕДУПРЕЖДЕНИЕ Sphinx: autodoc: не удалось импортировать класс, ошибка
Я пытаюсь использовать Sphinx для создания документов для некоторого класса Python. У меня есть один скрипт Python с одним классом (с некоторыми документами)
Мой скрипт python находится здесь: D: \ sphynx \ scripts \ src \ test.py
Не уверен, что...
1438 просмотров
schedule
25.12.2023
Как создать ссылку на dict с помощью sphinx-autodoc?
:data:`~package._module._DICT_NAME`
Не работает, _DICT_NAME отображается как ссылка, но без гиперссылки. То же самое с :obj: . Включение его в функцию - неприемлемый обходной путь.
Минимальный conf.py :
extensions =...
473 просмотров
schedule
13.01.2023
директива отображается как буквальный текст в отображаемом документе
Я хочу отобразить строки документации для двух функций между несколькими заголовками разделов следующим образом:
===
API
===
.. autofunction:: parsons.aws.distribute_task
.. autofunction:: parsons.aws.event_command
***
S3
***
Обе строки...
35 просмотров
schedule
28.11.2022
Как napoleon и autodoc взаимодействуют, документируя участников
Я заметил изменения в том, как Sphinx отображает описания классов. Учитывая этот код
# my example happens to be a dataclass, but the behavior for
# regular classes is the same
@dataclass
class TestClass:
"""This is a test class...
438 просмотров
schedule
07.01.2023
Есть ли способ переопределить текст, отображаемый директивой автокласса reST?
Я создал документацию, используя директиву autoclass в reST, и она генерирует заголовок для класса следующим образом:
Однако я хочу, чтобы он не говорил dataframe.DataFrame , а вместо этого EzPyZ.DataFrame (или действительно любое ручное...
44 просмотров
schedule
03.06.2023
