Вопросы по теме 'python-sphinx'
редакторы для таблиц в Sphinx/reStructuredText?
Я смотрю на использование Sphinx/reStructuredText для документации, и это выглядит очень многообещающе, за исключением того, что таблицы выглядят как боль. Есть ли редактор, который может помочь?
3224 просмотров
schedule
23.12.2022
Включить текстовый файл *как есть* в (Python) Sphinx Docs
(с использованием инструмента документации Python-Sphinx)
У меня есть файл журнала .txt , который я хочу встроить в _build/html без изменений . Что мне нужно изменить в conf.py , index.rst и т.д.
Вот макет:
src/
index.rst...
12731 просмотров
schedule
04.01.2024
Как создать документацию на основе Sphinx в проекте Jython?
Я работаю над несколькими проектами Jython, используя библиотеки, написанные на Java. Я хотел бы создать хорошую документацию с помощью Sphinx благодаря расширению autodoc. Однако, когда я пытаюсь создать html, я получаю ошибки, потому что autodoc...
2011 просмотров
schedule
26.09.2023
Преобразование Python 3 в простой Python, который может быть прочитан autodoc
Я написал программу на Python 3 и использую Sphinx для ее документирования. Autodoc Sphinx великолепен, однако он работает только с Python 2. Некоторые модули прекрасно работают в autodoc, а модули — нет. Некоторые примеры: Python 2 жалуется на...
448 просмотров
schedule
26.06.2023
Как сгенерировать табличный вывод в reStructuredText без использования формата таблицы RST?
Я пытаюсь перенести наши документы API и схему генератора проприетарной документации в reStructuredText. Сложнее всего то, что у нас есть табличное представление деталей API, закодированное непосредственно в HTML, а-ля:...
1265 просмотров
schedule
24.10.2022
Установка среды python / sphinx в windows?
Мы используем Sphinx для документации в нашей среде Python / Linux / OSX, но у нас есть кто-то в Windows, кто хотел бы могут получить среду, в которой они могут редактировать и создавать документацию Sphinx.
Можно ли настроить Sphinx на windows?...
10023 просмотров
schedule
27.09.2022
Документирование файлов с импортом из x *
Можно ли использовать sphinx .. automodule:: и другие автоматические функции для документирования модулей, содержащих операторы from x import * , без включения всей документации из импортированных модулей?
РЕДАКТИРОВАТЬ: Согласно точке зрения...
434 просмотров
schedule
18.04.2022
форматирование csv-таблицы через преамбулу?
Как бы я ни старался, я не могу понять, как изменить формат таблицы по умолчанию в выводе pdf из sphinx.
Я мог бы отредактировать файл .tex или исходный код Writer.py... но оба эти варианта кажутся плохими.
Есть ли что-нибудь, что можно передать...
991 просмотров
schedule
12.04.2022
Просмотреть строки документации reStructuredText (Sphinx) в iPython?
Есть ли способ, чтобы IPython полностью отображал строки документации reStructuredText (для Sphinx), когда вы вводите следующее:
help foo
or:
foo?
Меня супер отвлекает попытка прочитать справочную документацию в IPython, когда она...
1402 просмотров
schedule
04.06.2023
Добавление тега скрипта javascript в какое-то место, чтобы он работал для каждого файла в документации sphinx
Я использую Sphinx, чтобы писать заметки. Я использую расширение Mathjax для математики в заметках. Размер математики по умолчанию немного больше, чем хотелось бы. На странице Mathjax я обнаружил, что могу изменить этот размер, добавив следующий...
4311 просмотров
schedule
01.07.2023
Исключение при использовании Sphinx для документирования скрипта с аргументами командной строки
Есть ли способ использовать Sphinx для документирования входных данных командной строки скрипта Python? Я могу документировать ввод функций или методов, но я не знаю, как документировать ввод скриптов. Я пытался следовать тому же синтаксису, который...
342 просмотров
schedule
16.12.2022
Новая установка sphinx-quickstart не удалась
Попытка запустить его со Sphinx в первый раз, с чистой установкой Sphinx 1.1.3, и shinx-quickstart терпит неудачу. Должны ли быть установлены какие-либо зависимости? Пробовал pip --force-reinstall sphinx но результат тот же.
myhost:doc...
6863 просмотров
schedule
16.05.2023
sphinx-build: ошибка: нераспознанные аргументы: -b html build/doctrees source build/html
Я использую Sphinx для документирования своего проекта. когда я запускаю make html , я получаю эту ошибку.
Я установил Sphinx v1.1.2 . В некоторых файлах .rst может быть какая-то ошибка, но это сообщение об ошибке бесполезно, так как я не...
2070 просмотров
schedule
27.03.2023
Документация Sphinx API для Javascript
Я широко использую Sphinx для документации и чувствую себя комфортно с ним.
Тем не менее, я больше занимался Javascript (внешний интерфейс), чем Python.
Существуют ли какие-либо подключаемые модули или способы создания аналогичной документации...
1899 просмотров
schedule
14.08.2022
Как я могу предоставить документацию Sphinx для именованного кортежа (с помощью autodoc)?
Я пытаюсь задокументировать проект Python с помощью Sphinx, но у меня возникают проблемы с объединением расширения autodoc с созданным namedtuple классом.
В одном документе gammatone.rst у меня есть:
:mod:`gammatone` -- gammatone...
3242 просмотров
schedule
07.05.2022
Свойства модуля документа Sphinx
У меня есть модуль, который должен иметь @property , я решил это, установив класс в качестве модуля. Я получил идею из этого ответа: это сделать?
Я хотел, чтобы это было повторяемым и простым в использовании, поэтому я сделал для него...
3801 просмотров
schedule
06.09.2022
Включить определенные специальные методы в sphinx
У меня есть куча классов, которые используют "специальные методы":
class Foo(object):
"Foo docstring"
attr1 = "Attribute!" #: first attribute
attr2 = "Another Attribute!" #: second attribute
def __init__(self):
self.x = 12...
5594 просмотров
schedule
26.06.2023
Как создать плавающие фигуры в reStructuredText / Sphinx?
Я хочу иметь фигуру с обернутым вокруг нее текстом.
Вот что я говорю:
Installation of Optional Accessories
====================================
.. warning:: Never plug in or unplug a Hand Robot or a Grasp Sensor while the robot is turned on,...
3743 просмотров
schedule
09.04.2023
Как мне избежать СЕРЬЕЗНЫХ предупреждений о повторяющихся идентификаторах для моих модулей autodoc'd в Sphinx?
Я использую rST / Sphinx для документирования моего Python, однако при создании он выдает предупреждения, такие как
...Code/doc/code.rst:3: SEVERE: Duplicate ID: "module-toast".
Мои исходные файлы Python задокументированы следующим образом:...
2731 просмотров
schedule
11.07.2023
Как NumPy обрабатывает строки документации в документации sphinx для параметров?
Я хочу создать нашу документацию с помощью sphinx и получить такое же форматирование параметров, как и в документации NumPy ( https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt )
Я нашел два способа документировать параметры в...
3099 просмотров
schedule
17.05.2023
