Вопросы по теме 'python-sphinx'
Документация Sphinx по шаблонным тегам Django
Я использую Sphinx с autodoc для документирования моего проекта Django.
Дизайнеры хотят иметь страницы документации обо всех тегах шаблонов, которые определены в проекте. Я, конечно, могу сделать такую страничку, перебрав все функции обработки...
948 просмотров
schedule
20.03.2024
Как сделать внутреннюю гиперссылку в документации Sphinx
Как сделать внутреннюю гиперссылку в документации Sphinx? Я использую:
:role:`target`
Но это не работает.
15060 просмотров
schedule
24.03.2024
Как установить глубину Sphinx и latexpdf toc?
У меня есть проект vanilla sphinx (Sphinx 1.2b3.), созданный с помощью «sphinx-quickstart».
Я добавляю базовый page.rst с 4 уровнями заголовков.
Я могу контролировать глубину html toc в index.rst:
.. toctree::
:maxdepth: 1
:numbered:...
2524 просмотров
schedule
12.05.2024
Как сгенерировать черно-белый pdf из сфинкса?
Я хочу создать PDF-файл из сфинкса, который будет только черно-белым. Стандарт sphinx.sty использует \RequirePackage{color} и \RequirePackage{fancyvrb} .
Если я просто уберу color , то получу целый список ошибок. Мне не удалось найти...
201 просмотров
schedule
09.12.2022
Где находится каталог документов django-sphinxdoc
Я хотел бы использовать пакет django-sphinxdoc для документации внутри моего проекта django. Есть сайт https://pypi.python.org/pypi/django-sphinxdoc/ этого пакета и говорит:
Документацию можно найти в каталоге docs/.
Я не могу найти...
164 просмотров
schedule
07.11.2023
Заголовки разделов на боковой панели Sphinx
Есть ли способ добавить заголовки разделов в левое меню документации Sphinx? Я знаю, что вы можете сделать это, если используете MkDocs (например, здесь ), но есть ли как это сделать в тексте Sphinx и ReSTructured?
Я хочу разделить свою...
1423 просмотров
schedule
27.01.2024
Добавить класс в таблицу в Sphinx?
Сначала у меня есть таблица, и я хочу добавить к ней класс при компиляции в HTML с помощью Sphinx. Согласно документам , добавление директивы .. class:: перед таблицей должно добавить класс в таблицу, но вместо этого он добавляет список...
4692 просмотров
schedule
11.01.2024
Как определить название ссылки, без исходного заголовка? (реструктурированный текст)
В reStructuredText обычно используются ссылки для ссылки произвольные места в документе.
При отсутствии названия необходимо дать подпись со ссылкой. например:
Some text in a paragraph.
.. _my-reference:
Some more text.
Link to :ref:`My...
152 просмотров
schedule
17.09.2022
Как добавить начальные/конечные пробелы в моноширинный текст в Sphinx reStructuredText
Заголовок говорит сам за себя... это работает для создания моноширинного текста:
``foo``
но это не так:
`` foo``
``foo ``
Как я могу получить начальные/конечные пробелы в моноширинном тексте? (прежде чем кто-то процитирует мне...
538 просмотров
schedule
14.09.2022
Может ли Sphinx autodoc документировать namespace.module без документирования пространства имен?
Кодовая база, с которой я работаю, структурирована по схеме namespace . Я отвечаю за namespace.my_project , но я завишу от различных других модулей из namespace . Есть ли способ указать Sphinx (с autodoc) документировать namespace.my_project ,...
422 просмотров
schedule
31.10.2023
Как сделать ссылку из документа Sphinx в файл CHM?
Как я могу связать документ Sphinx с файлом CHM?
Кажется, я мог бы связать один файл chm с другим, используя синтаксис вроде
<a href="ms-its:path+filename.chm::/pagename.htm">
Можно ли передать это в команды Sphinx?
471 просмотров
schedule
20.10.2022
Sphinx — в чем разница между toctree и контентом?
Я могу создать оглавление двумя способами:
.. contents::
:local:
depth: 1
or as
.. toctree::
:maxdepth: 1
index
В чем разница? Где я должен использовать toctree и где содержимое?
841 просмотров
schedule
21.09.2022
Sphinx не перезаписывает таблицы стилей css
У меня есть документация по сборке Sphinx.
В source/conf.py у меня есть
def setup(app):
app.add_stylesheet('conduce-style.css')
в conduce-style.css
h1 {
font-family: 'Gotham Ultra';
}
Затем, когда он отображает:...
200 просмотров
schedule
29.10.2022
c++ doxygen + таблицы дыхания
У меня есть большой проект С++, задокументированный с помощью doxygen. Я хочу использовать дыхание, чтобы делать более приятные руководства. Документация в исходном коде часто содержит такие таблицы:
/**
* @var somevar
* @brief some variable...
929 просмотров
schedule
24.02.2024
Объявить дополнительную зависимость от sphinx-build в расширении
TL,DR: Из расширения Sphinx, как я могу указать sphinx-build рассматривать дополнительный файл как зависимость? В моем непосредственном случае использования это исходный код расширения, но вопрос в равной степени может относиться к некоторому...
219 просмотров
schedule
08.05.2024
Как создать пользовательские предупреждения в пользовательской директиве sphinx?
Я создал пользовательскую директиву «ограничение» в Sphinx, в которой упоминается «Ограничение» определенного продукта. Я хочу, чтобы ограничение было написано в цветном поле, похожем на директивы «примечание» или «предупреждение», с надписью...
471 просмотров
schedule
11.01.2024
Почему имена некоторых пакетов Python отличаются от имени импорта?
Некоторые пакеты импортируются со строкой, которая отличается от имени пакета в PyPI, например:
$ pip list | grep -i "yaml\|qt"
PyYAML 3.13
QtPy 1.5.2
pyyaml (pip instal pyyaml), но импортировать yaml
qtpy...
1540 просмотров
schedule
29.05.2024
Почему sphinx-apidoc не может найти пакет в этой сборке travis/tox?
Сборка Трэвиса: https://travis-ci.com/Laurentiu-Andronache/he/jobs/184044676
conf.py: https://github.com/Laurentiu-Andronache/he/blob/master/docs/source/conf.py
tox.ini: https://github.com/Laurentiu-Andronache/he/blob/master/tox.ini (см....
55 просмотров
schedule
21.09.2022
Возникло исключение при попытке добавить узел pending_xref к signode.
Я пытаюсь добавить узел pending_xref к signode функции handle_signature , но получаю исключение в скрипте docutils:
Произошло исключение: файл "\python\python37-32\lib\site-packages\docutils\nodes.py", строка 569, в __getitem__...
127 просмотров
schedule
01.06.2024
Импорт нескольких таблиц из файлов в Sphinx в формате .rst
Я хочу импортировать несколько таблиц из нескольких исходных файлов .csv в один файл .rst . Пример ниже .rst :
=======
Section
=======
subsection01
------------
.. csv-table:: my_table1
:file: my_file1.csv
subsection02
------------
.....
101 просмотров
schedule
03.03.2024
