Вопросы по теме 'python-sphinx'
Как установить генератор документации python sphinx в linux?
И как мне его запустить?
5153 просмотров
schedule
14.12.2022
Как в Sphinx создать ссылочный раздел терминологии без огромных накладных расходов?
Я хочу создать раздел «терминология» с определениями терминов, которые я использую, чтобы каждый раз, когда я использую термины в этом разделе терминологии, создавалась ссылка, указывающая на определение.
В настоящее время лучшее, что я могу...
2571 просмотров
schedule
11.01.2024
Автоматическое создание документации для всего содержимого пакета Python
Я пытаюсь автоматически сгенерировать базовую документацию для своей кодовой базы с помощью Sphinx. Однако у меня возникли трудности с указанием Sphinx рекурсивно сканировать мои файлы.
У меня есть кодовая база Python со структурой папок, например:...
25849 просмотров
schedule
21.09.2022
Включение источника в документацию Sphinx
Я пытаюсь использовать Sphinx для документирования моего проекта Python, но я борюсь с различиями между этим инструментом и обычными инструментами, такими как JavaDoc, которые предназначены для документирования API. Конечно, я вижу, что у Sphinx...
1711 просмотров
schedule
19.03.2023
Одновременное использование нескольких тем Sphinx
Я хочу использовать несколько тем в Sphinx, чтобы на одной странице была одна тема, а на второй странице - вторая. Мне кажется, что сразу может быть задана только одна тема - это правда?
Большое спасибо, Нед
371 просмотров
schedule
13.04.2023
Наследование строк документации для свойств с использованием 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, используя:
sphinx-quickstart
а затем я создаю свои...
6027 просмотров
schedule
26.05.2023
Автомодуль sphinx: как ссылаться на классы в одном модуле?
Я пытаюсь использовать расширение sphinx autodoc и в частности директива automodule для автоматического создания документации для приложения django, над которым я работаю. Проблема в том, что я хочу создавать внутренние ссылки на разные классы в...
23464 просмотров
schedule
16.09.2022
повторяющиеся параметры с python sphinx
Я новичок в python-sphinx и не могу найти ничего, касающегося следующего:
Предположим, у меня есть функции foo(a,b) и bar(a,c) , так что параметр a имеет одинаковое описание для обеих функций.
Можно ли задокументировать a только один раз...
683 просмотров
schedule
27.01.2023
автосуммарные и динамические методы sphinx
Я нашел много способов использования setattr() для создания динамически генерируемых методов и атрибутов класса. Я также использую sphinx для создания документации, и это просто фантастика.
Проблема в том, что я не могу использовать функцию...
537 просмотров
schedule
21.11.2022
Как изменить выходной каталог _target для HTML Builder в sphinx?
Я пытаюсь использовать Sphinx для создания документации для отправки на страницы github . Я использую конструктор html по умолчанию для создания справочной документации и помещаю ее в ветку gh-pages (см....
2211 просмотров
schedule
23.09.2022
Как импортировать модуль в Sphinx
import myModule as myModule
с этим кодом работает импорт, и я могу сделать свой документ
import myPackage.myModule as myModule
с этим я получаю
Нет модуля с именем myPackage.myModule
Не имеет значения, существует ли этот файл в...
3962 просмотров
schedule
14.09.2023
Разделение исходного документа в Sphinx (т.е. управление иерархией файлов)
Каков правильный способ разделения исходного документа в Sphinx?
У меня есть большой файл, назовем его file1.rst , структура которого такая:
Section 1
*********
Subsection 1
============
Subsection 2
============
Subsection 3
============...
1626 просмотров
schedule
01.08.2023
Темы Sphinx PDF
Предлагает ли инструмент документации Sphinx разные темы PDF, как и разные темы HTML?
Я погуглил проблему, но не нашел ответа, что заставляет меня думать, что ответ - «нет». Тем не менее, я подумал, что спрошу здесь.
Спасибо.
14092 просмотров
schedule
22.05.2022
Ссылка на длинные имена с помощью Python Sphinx
Я работаю над документацией для своего модуля Python (используя Sphinx и reST) и обнаружил, что при перекрестных ссылках на другие объекты Python (модули, классы, функции и т. д.) полное имя объекта оказывается невероятно длинным. Часто он длиннее 80...
3043 просмотров
schedule
16.12.2022
Автоматизация документации Django с помощью Sphinx
Я использую Sphinx для создания документации для проекта Django, и он работает очень хорошо. Однако представляется необходимым написать файлы .rst самостоятельно, и как только это будет сделано, sphinx скомпилирует документацию из строк документации,...
254 просмотров
schedule
16.02.2023
Переопределить объявление функции в 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
Токтри автосуммирования Sphinx содержит ссылку на предупреждения несуществующего документа.
Я пытаюсь автоматически создавать api-документы для большой базы кода Python с помощью Sphinx.
Я пробовал использовать build_modules.py и sphinx-apidoc. С помощью любого из них я могу получить первые документы, успешно созданные в моем выходном...
22764 просмотров
schedule
25.09.2023
Включить исходный код python в часть объявления функции заголовка sphinx
Я новичок в сфинксе. Ситуация, с которой я сталкиваюсь, заключается в том, что у меня есть сложная функция, и в документации sphinx я хотел бы показать некоторые примеры использования функции напрямую.
def myComplicatedFunction(status):...
759 просмотров
schedule
06.05.2023
Применение CSS и ролей для текстовых блоков вместо встроенных промежутков в Sphinx
Существует предыдущий вопрос , в котором объясняется, как добавить диапазон цветов в некоторый reStructuredText.
Чтобы резюмировать процедуру:
Во-первых, у вас есть роль.
.. role:: red
An example of using :red:`interpreted text`
Это...
5529 просмотров
schedule
20.09.2022
