У меня есть несколько модулей Python, содержащих в основном функции и несколько классов. Каждый из них задокументирован с помощью sphinx-autodoc в отдельном файле rst. Что я хочу сделать, так это создать таблицу или список модулей '...
Предлагает ли инструмент документирования Sphinx различные темы PDF, как он предлагает разные темы HTML? Я погуглил проблему, но не нашел ответа, что заставляет меня поверить, что ответ «нет». Тем не менее,...
Я пишу математический код на Python и использую Sphinx для создания документации. Я знаю, что Sphinx может обрабатывать код LaTeX в строках документации Python; см. http://sphinx.pocoo.org/latest/ext/math....
Есть ли способ установить цвет отдельных слов (или символов) в sphinx? Я почти уверен, что должен быть какой-нибудь тег разметки, например тег шрифта HTML.
Я использую Sphinx для написания некоторых заметок. Я использую расширение Mathjax для математики в заметках. Размер математики по умолчанию немного больше, чем хотелось бы. На странице Mathjax я обнаружил, что могу ...
Я использую Sphinx для создания HTML-документации для программы Python. Я хотел бы использовать общую директиву предостережения (см. Http: //docutils.sourceforge.net/docs/ref/rst/directives.html#generic -...
Каков правильный способ, если таковой имеется, разделения исходного документа в Sphinx? У меня есть большой файл, назовем его file1.rst, структура которого такая: Раздел 1
********* Подраздел 1
======= ...
В Ruby есть несколько хороших генераторов документов, таких как Yard, rDoc, даже Glyph. Дело в том, что Sphinx делает веб-сайты, PDF, epub, LaTex и т. Д. Все это он делает в реструктурированном тексте. Есть ли ...
У меня есть проект Python, в котором есть документация по Sphinx и distutils для публикации в Pip. Обе эти функции требуют версии (например, 0.4b3). Есть ли лучший способ для автоматического…
Когда я использую Sphinx autodoc для документирования класса, значения атрибутов всегда сообщаются (как он говорит он должен здесь, под # 437), но всегда как "= None" Attribute = None Some ...
Есть ли способ заставить IPython полностью отображать строки reStructuredText (для Sphinx), когда вы набираете: help foo или: foo? Я считаю, что это отвлекает от чтения справочной документации в IPython ...
Я пытаюсь использовать Sphinx для создания документации для отправки на страницы github. Я использую построитель html по умолчанию для создания справочной документации и помещаю ее в ветку gh-pages (см. Https: // github ....
Можно ли использовать Sphinx autodoc для создания документации для моего fabfile из строк документации функций? Например. для файла fabfile, содержащего задачу setup_development, я пробовал: .. automodule :: fabfile
...
Я хочу создать ссылку на раздел во внешнем файле, но не могу заставить его работать. : Ref: похоже, не работает глобально, или я неправильно его использую? .. Файл: some_file.rst .. _ref_section: Некоторые ...
Для моей JavaScript структуры я хотел бы использовать Sphinx. Поскольку я новичок в мире Sphinx, я хотел бы, чтобы вы помогли мне начать работу с Sphinx и JavaScript. Любая помощь будет принята с благодарностью. ...
У меня есть несколько примеров кода и данных, которые я копирую в каталог _static, и я хотел бы связать эти файлы в документации, например: .. _pca- run.py: _static / example.data Но проблема в том, что ...
Мы используем Sphinx для документации в нашей среде python Linux / OSX, но у нас есть кто-то в Windows, кто хотел бы получить среду, в которой они могут редактировать и построить Sphinx ...
Предполагается, что i имеет следующие значения: класс x {public static void main (String [] args) {List > a = new LinkedList < Object > (); Список расширяет объект > b = новый список LinkedList <...
Я использую sphinx с расширением pngmath для документирования моего кода, который содержит множество математических выражений. Выполнение этого в файле * .rst работает нормально. a \ times b становится: Однако, если я попытаюсь ...
Кто-нибудь знает какой-либо вариант упорядочить toctree в порядке убывания имен файлов?
В случае возрастания, мы можем использовать параметр: glob: примерно так: .. toctree :: glob: 2011 * Это было бы удобно ...
Я использую расширение Autodoc Sphinx для документирования модуля, и я хотел бы получить плоский список элементов модуля в выходных данных документации. Я пробовал использовать следующее: .. automodule :: modname
...
I Я новичок в python-sphinx и не могу найти ничего, посвященного следующему: Предположим, у меня есть функция foo (a, b) и bar (a, c), так что параметр a имеет одинаковое описание для обеих функций. Является ли ...
При создании документации с помощью Sphinx я хотел бы иметь возможность создавать две версии моей документации: одну, включающую все, и одну только с определенным набором страниц . Что за ...
Я хотел бы иметь возможность сначала анализировать sphinx в Python для дальнейшей обработки и проверки. Что-то вроде: import sphinx
p = sphinx.parse ("/ path / to / file.rst")
do_something_with (p) Кажется ...
В Sphinx, если у меня есть следующее объявление заголовка: .. _somestuff: `this is code`, это не так!
===== ========================= Он отображает примерно так: это код ...
У меня есть проект django, который я задокументировал с помощью reST в строках документации, чтобы сделать следующее: Помогите diagloags в среде IDE
Позже для создания документации HTML с помощью Sphinx My документация отображается правильно ...
Я пытаюсь использовать расширение sphinx autodoc и, в частности, директиву automdule для автоматического создания документации для приложения django, над которым я работаю. Проблема в том, что я хочу создать ...
Скажите, что мой файл some.rst выглядит следующим образом: ============.
Мой титул
============ 1. Раздел
================ 2. Раздел
================= После компиляции, в результирующем файле some.html появится таблица ...