Вопросы по теме 'restructuredtext'
Sphinx: проиндексированный элемент с перекрестными ссылками
Как я могу сделать перекрестную ссылку на проиндексированный элемент внутри документа reStructuredText?
Например, как я могу ссылаться на SectionB:
.. index::
pair: SectionA; SectionB
SectionB
--------
SectionB description.
Я...
2885 просмотров
schedule
01.08.2022
создание образов в директивах reST
Я пытаюсь создать директиву reStructuredText, которая берет ее содержимое, создает изображение на основе этого содержимого с помощью PIL, а затем отображает сгенерированное изображение в документе. Пока что я сделал подкласс директивы изображения,...
151 просмотров
schedule
08.08.2022
Сначала измените переменную с помощью pandoc
Я преобразовываю документ .rst в .tex с помощью pandoc и хочу изменить переменные, такие как $date в документе .rst . Я использую:
============
My doc title
============
:Date: October
My first title
==============
Lipsum…...
310 просмотров
schedule
17.03.2024
Пусть Emacs редактирует строки документации Python, используя rst-mode
Как заставить Emacs использовать rst-mode внутри строк документации в файлах Python? Я смутно помню, что возможны разные режимы в пределах определенных областей файла, но я не помню, как это делается.
1363 просмотров
schedule
29.07.2022
Списки reStructuredText с пользовательским перечислителем
Рассмотрим пункт "2-3)" в списке "Сложность" на http://en.cppreference.com/w/cpp/container/vector/vector . Как я могу добиться того же в reStructuredText/Sphinx?
Самое близкое, что я получил, было писать
| 1) ...
| 2-3) ...
| 4) ...
но...
89 просмотров
schedule
17.04.2024
Перекрестная ссылка Sphinx не работает
В моей документации в стиле scipy у меня есть:
..., see :ref:`notes <filt_int_notes>`.
Other text.
.. _filt_int_notes:
Notes
-----
Some cool notes.
Согласно Добавление перекрестной ссылки на подзаголовок или привязка на другой...
1461 просмотров
schedule
28.09.2022
Ошибка: не допускается содержание в директиве рубрики
Файл, который я пытаюсь добавить, содержит ряд рубрик, но с ними я получаю странную ошибку. Должно быть, я делаю что-то глупое, но я не могу понять, в чем дело. Вот мой документ:
==========================
Coding Conventions...
2103 просмотров
schedule
07.04.2024
Sphinx: ссылка на встроенные двоичные файлы (PDF)
Я использую sphinx и RST для создания технической документации в формате HTML, и у меня возникают проблемы с получением локальной ссылки PDF для работы в качестве гиперссылки. Я видел, как люди использовали :download: для ссылки на локальные...
2006 просмотров
schedule
26.12.2023
Как задокументировать несколько возвращаемых значений с помощью reStructuredText в Python 2?
В документах Python говорится, что «для документации Python используется разметка reStructuredText ". Мой вопрос: как должен быть написан комментарий блока, чтобы отображать несколько возвращаемых значений?
def func_returning_one_value():...
10595 просмотров
schedule
28.10.2023
README.rst не анализирует pypi, но дозирует testpypi
После того, как я выпустил новую версию своего пакета, по какой-то причине pypi перестал показывать файл README.rst.
Изменения были минимальными, вот разница между двумя версиями файла README.rst. Не могу понять, что его сломало...
Я также...
88 просмотров
schedule
04.03.2024
Sphinx удаляет форматирование кода из справочника пользовательского кода
У меня есть следующие занятия:
class A:
def x():
""" Do the thing. """
class B(A):
def x():
"""
Do the thing, but better than the :py:meth:`parent <A.x>`
"""
Весь модуль autodoc ed. Я хотел бы...
147 просмотров
schedule
12.12.2023
Отображение окна предупреждения на страницах, сгенерированных python-sphinx
Как отобразить окно предупреждения в html, сгенерированном с помощью sphinx-build ?
Warning
Do not use the directives sectnum, header and footer.
Я хочу показать вышеуказанное сообщение примерно так: (извините, SO не t позвольте мне...
1188 просмотров
schedule
13.05.2024
Можно ли в Sphinx сохранить длинные строки?
В моем входном файле restructuredText для Sphinx есть длинная строка:
This is a long line text that I want to keep as a long single line. It should not be wrapped in the text output.
Используя конструктор текста Sphinx, я получаю такой вывод:...
996 просмотров
schedule
20.04.2024
Исключить комментарии reStructuredText в выводе Sphinx HTML
Я хотел бы добавить несколько комментариев в документ reStructuredText, которые не отображаются, когда я создаю свою документацию. Например, я хотел бы поместить в файл следующее:
This is the source of my .rst file. I would like the following...
334 просмотров
schedule
11.10.2022
Полужирный текст ReStructuredText с нижним индексом
Возможно ли иметь нижний индекс внутри полужирного текста в реструктурированном тексте?
i.e.
**H :sub:`2` O**
Будет отображаться жирным шрифтом `H :sub:`2` O вместо H2O (с индексом 2).
Я предполагаю, что из этой темы это не так:...
224 просмотров
schedule
13.01.2024
Как связать повторяющиеся цели в reStructuredText?
У меня есть два повторяющихся ключа -> .. command:: targetName в моем документе на двух разных страницах. Мне нужно знать, как я могу связать эти две отдельные цели, используя следующий синтаксис:
Page-1 Click this -> :command:`targetName` #...
35 просмотров
schedule
13.11.2022
Как устанавливается выравнивание блоков кода в таблицах в строках документации?
Я пытаюсь включить кодовые часы в таблицы в строках документации, которые интерпретируются Sphinx. Я пробовал следующее:...
63 просмотров
schedule
30.10.2023
Предупреждение о неизвестной пользовательской интерпретируемой текстовой роли
В моем экземпляре Sphinx-doc у меня есть:
в конце моего файла conf.py :
rst_prolog = """
.. role:: LaTeXLogo
"""
в некоторых из моих .rst файлов:
:LaTeXLogo:`LaTeX`
Но это не работает, так как...
246 просмотров
schedule
20.07.2022
Повторение или ссылка на рисунок в другом первом файле
У меня есть два файла с именами a.rst и b.rst , оба из которых содержат много текста. В a.rst я определяю цифру:
.. figure:: ../images/some-image.png
:scale: 70%
:align: center
:alt: Some Text
Some Caption
Я хотел бы...
103 просмотров
schedule
30.08.2022
