Вопросы по теме 'autodoc'
Наследование строк документации для свойств с использованием autodoc от sphinx
У меня есть такой класс:
class MyBase(object):
x = 3
"""Documentation for property x"""
и еще один класс, наследующий его:
class MyObj(MyBase):
x = 0
Когда я использую autodoc sphinx для создания документации, MyObj.x не...
3763 просмотров
schedule
23.04.2023
Автомодуль sphinx: как ссылаться на классы в одном модуле?
Я пытаюсь использовать расширение sphinx autodoc и в частности директива automodule для автоматического создания документации для приложения django, над которым я работаю. Проблема в том, что я хочу создавать внутренние ссылки на разные классы в...
23464 просмотров
schedule
16.09.2022
Переопределить объявление функции в autodoc для sphinx
У меня есть модуль, который выглядит примерно так:
#!/usr/bin/env python
#: Documentation here.
#: blah blah blah
foobar = r'Some really long regex here.'
def myfunc(val=foobar):
'''Blah blah blah'''
pass
... и у меня есть файл...
4819 просмотров
schedule
21.09.2022
Заставить autodoc sphinx показывать значения по умолчанию в описании параметров
У меня есть следующая строка документации:
def progress_bar(progress, length=20):
'''
Returns a textual progress bar.
>>> progress_bar(0.6)
'[##########--------]'
:param progress: Number between 0 and 1 describes the...
2743 просмотров
schedule
06.01.2023
Ошибка автоматического создания документации Sphinx python
Я хотел бы сделать документацию для API под названием Ulyxes PyAPI. Я уже запустил его, но процесс автогенерации не работает. Когда я нажимаю ссылку «Автоматически сгенерированный документ» на моей странице index.html, меня перенаправляют на пустую...
452 просмотров
schedule
21.06.2022
Как документировать участников в определенных разделах с помощью Sphinx?
Я изо всех сил пытаюсь понять, как разместить документацию для конкретных членов моего класса Python в определенных разделах моей документации Sphinx, в идеале, при автоматическом документировании остальных в другом разделе.
У меня есть класс...
1168 просмотров
schedule
13.06.2022
Переопределение псевдонима автодока Sphinx для импорта частного класса?
У меня есть пакет Python, который я пытаюсь задокументировать с помощью sphinx-autodoc. В моем пакете python есть __init__.py файл, который импортирует класс из подмодуля, чтобы сделать его доступным на уровне пакета.
from a.b.c.d import _Foo as...
1315 просмотров
schedule
24.11.2022
Структура каталогов Sphinx для сгенерированных файлов rst и html
Я работал над настройкой автоматической документации для моих файлов Python, которые находятся в большой иерархии структуры каталогов. Я могу сгенерировать файлы rst и html для всех из них с помощью моих скриптов и с помощью модуля autodoc. Мне было...
783 просмотров
schedule
12.06.2022
Sphinx autodoc неправильно присваивает значение «Нет» атрибутам класса, когда используются черты
Я вижу, что атрибутам class Python неправильно присваивается значение None в документации, созданной Sphinx autodoc , когда используются Traits .
У меня есть простой тестовый пример с инструкциями по наблюдению за ошибкой, здесь:...
123 просмотров
schedule
25.03.2023
Sphinx добавляет индекс всего модуля в сгенерированный PDF
Я использую Sphinx autodoc для создания документации по Python, которая затем размещается в ReadTheDocs здесь . PDF-файл, созданный ReadTheDocs, содержит только оглавление моей индексной страницы, которое вы можете увидеть здесь .
Я хочу, чтобы...
631 просмотров
schedule
05.12.2022
Sphinx- Как сделать autodoc файлы .py, расположенные в нескольких папках?
Я новичок как в Python, так и в Sphinx, и я пытаюсь скопировать файлы Python в autodoc, расположенные в каталоге, структура которого аналогична следующей:
Project
├── Sphinx
| ├── index.rst
| ├── autodoc.rst
| └── conf.py
├── Scripts
|...
3165 просмотров
schedule
01.09.2022
Sphinx autodoc дублирует имя модуля и имя функции
У меня есть модуль Python со следующей структурой:
my_mod
|--- __init__.py
|--- mod1
| |---- __init__.py
|---- testA.py
|---- testB.py
|---- testC.py
Внутри каждого testX.py есть одна функция с именем testX . Эти функции...
330 просмотров
schedule
23.07.2022
Показаны только частные методы с Sphinx Autodoc
Здесь есть несколько вопросов о показе закрытых методов с помощью Autodoc, но я ничего не видел о показе только закрытых методов.
Приватные методы и обычные методы могут быть показаны следующим образом:
.. autoclass::...
181 просмотров
schedule
25.05.2023
алебастр, как отображать параметры с фиксированным шрифтом
Редактировать №1
добился некоторого прогресса, но все еще не понял: мне удалось использовать монофонический шрифт, настроив мой custom.css следующим образом:
em.property{
font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono',
'Bitstream Vera...
43 просмотров
schedule
28.04.2023
Использование Jinja2 с автосводкой Sphinx
Я пытаюсь использовать sphinx.ext.autosummary документировать пакет Python. Поскольку «автосводка» требует, чтобы мы перечислили все элементы, которые должны быть включены, я хотел указать их с помощью Jinja2.
Мой conf.py выглядит следующим...
1140 просмотров
schedule
18.11.2022
Трудности с документированием классов enum?
Я пытаюсь задокументировать поддерживаемый мной модуль, и мне очень трудно правильно задокументировать мои классы перечисления. Например, вот тот, который я хотел бы правильно задокументировать ( источник ):
class QOSLevel(Enum):
'''Quality...
118 просмотров
schedule
21.09.2022
Игнорировать предупреждения Sphinx autodoc для значений rtype
Прямо сейчас autodoc, кажется, выдает предупреждения для любого значения rtype , которое не является просто типом объекта (экземпляр класса, int, список, словарь и т. д.). Таким образом, возвращаемое значение, такое как список кортежей, вызовет...
217 просмотров
schedule
02.10.2022
Строки документации не включены в сборку Read the Docs Sphinx.
Я создал документацию Sphinx, и эта сборка хорошо работает локально. Мои строки документации выглядят так, как показано ниже.
При переходе на readthedoc.io я добавил конкретный файл требований в docs/requirement.txt , а именно:...
109 просмотров
schedule
28.06.2022
