Описание тега python-sphinx

Описание тега Вопросы с тегом
Sphinx - это инструмент, который упрощает создание интеллектуальной и красивой документации. Sphinx особенно подходит для документации Python, но это инструмент общего назначения, который можно использовать для документирования чего угодно.
0 ответов

Как вы гиперссылки моноширинный текст в reStructuredText?

`pandoc &lt;https://github.com/jgm/pandoc&gt;`_ создает ссылку, которая выглядит как pandoc Но как мне создать ссылку на моноширинный текст: pandoc Если я попробую ` ``pandoc`` &lt;https://github.com/jgm/pandoc&gt;`_ Я получаю это грубое ` pandoc < …
19 апр '16 в 23:29
1 ответ

Можно ли вставить гиперссылки в литеральный блок ReST?

Я знаю, что такое поражение является целью буквального блока, однако мне было интересно, есть ли способ обойти это. Мой вариант использования - поместить гиперссылку в литерал блока псевдокода, чтобы ссылаться на детали в другом месте документа. При…
13 апр '17 в 09:26
1 ответ

Можно ли добавлять греческие буквы в документы Sphinx в качестве терминов глоссария?

Я хочу добавить переменные, которые определены как греческие буквы к моему глоссарию в документе сфинкса. Например: .. glossary:: :math:`{\alpha}` Definition for alpha Цель состоит в том, чтобы эти переменные появились в индексе документа. Кто-нибуд…
29 ноя '16 в 01:37
2 ответа

Использование Sphinx с дистрибутивом C-расширения

Я написал модуль Python, включая подмодуль, написанный на C: сам модуль называется foo и часть C foo._bar, Структура выглядит так: src/ foo/__init__.py &lt;- contains the public stuff foo/_bar/bar.c &lt;- the C extension doc/ &lt;- Sphinx configurat…
14 янв '11 в 03:05
0 ответов

Сфинкс - эффективная ссылка на файлы.rst вне дерева?

Я хочу собрать документацию Sphinx для проекта со структурой, подобной этой: doc: index.rst conf.py Makefile modules: module1: README.rst module2: README.rst Я хотел бы легко включить предыдущие файлы README.rst в мою документацию по Sphinx. Однако …
30 янв '18 в 10:21
1 ответ

Sphinx + HTML Help Workshop: отдельная страница для каждого раздела

После создания *.rst файлов с помощью Sphinx я создаю файл CHM с помощью HTML Help Workshop. Мой файл index.rst до сих пор: .. toctree:: :maxdepth: 2 _static/presentation_designer/feedback _static/presentation_designer/test У меня есть два *.rst фай…
13 дек '16 в 22:13
1 ответ

Скрыть определенные файлы из toctree

Я использую экземпляр readthedocs.org на своем локальном хосте для создания HTML-документации из моего репозитория github, и я хотел бы иметь возможность сделать следующее. В настоящее время у меня есть список файлов, которые читаются с помощью функ…
29 ноя '13 в 10:15
0 ответов

Можете ли вы получить нормальные подписи к рисункам для графов (орграфов) с помощью генератора документов Sphinx Python?

Можете ли вы использовать подписи к рисункам для графиков, созданных Graphviz (digraph) с помощью Sphinx? Я хотел бы использовать ту же нумерацию и стиль надписей для моих графиков Graphviz, как и для всех рисунков. Например, если я попытаюсь встави…
25 ноя '18 в 10:29
2 ответа

Условно включить расширения?

Есть ifconfig расширение сфинкса - и оно позволяет условно включать контент. Я ищу способ условно включить расширения. Моя лучшая попытка - дать список расширений с -D возможность sphinx-build: sphinx-build -b singlehtml -d _build/doctrees -D html_t…
31 май '13 в 18:17
1 ответ

Как заставить BuildDoc работать только когда python-sphinx установлен из файла setup.py?

У меня есть setup.py файл для моего проекта FlashText: from setuptools import setup, Command from sphinx.setup_command import BuildDoc setup( . . cmdclass={'test': PyTest, 'build_sphinx': BuildDoc}, ) pip install flashtext терпит неудачу, если pytho…
08 сен '17 в 07:33
1 ответ

Как я могу сделать сборку sphinx-build быстрее?

Документация sphinx-build говорит, что он перестраивает только измененные файлы. Но в этом проекте он перестраивает все выходные файлы для каждого модуля. Этап "Подсветка кода модуля" занимает особенно много времени. Исходные файлы Python вообще не …
23 авг '18 в 12:55
1 ответ

Как мне сослаться на пользовательский индекс, созданный в моем собственном расширении сфинкса?

Я работаю над расширением сфинкса, который включает в себя пользовательский индекс, как это: from sphinx.domains import Index class MyIndex(Index): """ Index subclass to provide the Python module index. """ name = 'funcindex' localname = 'Function I…
31 окт '14 в 10:53
0 ответов

Sphinx autodoc не может импортировать / найти модуль

Я новичок в сфинксе. Я получил что-то в самом начале. Моя структура файлов действительно проста: conf.py index.rst p1.rst p1 (документ) m1.py (файл в p1) m2.py (файл в p1) ... в p1.rst пишет: .. automodule:: p1.m1 :members: и я добавляю абстрактный …
07 янв '15 в 11:51
1 ответ

Сфинкс зависает при попытке использовать возможности amxmath

Я хочу определить матрицу в математическом блоке в файле ReST, как это; .. math:: \[\begin{bmatrix}a_1 &amp; b_1\\ a_2 &amp; b_2\end{bmatrix}\] В моем conf.py я определил преамбулу, чтобы включить amsmath пакета LaTeX latex_elements = { # Additional…
30 окт '17 в 10:37
0 ответов

Сфинкс против Пидока

Я решаю, использовать ли Sphinx или Pydoc для документирования большого существующего проекта. Какой из них выбрать? Какой из них лучше работает в данных условиях? Какой из них быстрее настроить запуск проекта?
09 сен '13 в 23:04
0 ответов

Как заставить Sphinx генерировать "последние изменения" из времени доступа к исходным файлам для отдельных страниц?

Я работаю над проектом документации со sphinx и темой ReadTheDocs. Исходные файлы находятся в git-репозитории на gitlab, и я использую автоматическое тестирование для проверки правильности сборки документации при каждом слиянии с основной веткой. Я …
30 ноя '18 в 09:25
0 ответов

Возможность указать цвета фона таблицы?

При использовании метода latex->pdf вы можете настроить вывод латекса, используя ряд опций в вашей конфигурации sphinx, я хочу настроить цвет заголовка таблицы. Как я могу решить эту проблему?
05 окт '16 в 14:41
2 ответа

Как я могу добавить внешний файл Python в мой реструктурированный текстовый документ?

Я хочу написать книгу, используя Sphinx и реструктурированный текст. Поскольку большая часть контента будет написана на Python, я хочу разделить текст и код. Есть ли команда для добавления внешних скриптов Python в мои реструктурированные текстовые …
14 сен '13 в 12:21
2 ответа

Документирование команд CLI с помощью Sphinx doc

Мне нужно документировать многие команды CLI, используя Sphinx doc. Я искал повсюду расширение, которое можно было бы использовать для получения вывода, аналогичного тому, как github документирует команды CLI: https://developer.github.com/v3/ Есть л…
15 май '14 в 20:17
3 ответа

Python Sphinx исключает шаблоны

Я генерирую документацию с помощью Sphinx для проекта со структурой, подобной этой: + project | +- docs | +- tests | +- workflow -+- definitions -+- &lt;some folders&gt; | +- &lt;rest of the project&gt; Я хочу исключить тесты и рабочий процесс / опр…
05 май '17 в 09:41