restructuredtext — все вопросы

1ответ
4 голоса
Python: Как я могу определить в sphinx, какие файлы и каталоги .rst следует использовать?
Как определить в sphinx, какие файлы и каталоги .rst следует использовать? Я хочу включить автоматический генератор документации в мой скрипт тестирования /сборки /документации. sphinx-quickst
1ответ
4 голоса
Как обслуживать статические ресурсы без изображений с сайта readthedocs?
У меня есть папка assets в моем docs Изображения правильно встраиваются в мою документацию, но любые ссылки на образцы входных файлов (статические файлы, которые являются входными данными для двои
1ответ
4 голоса
извлекать код из директивы кода из реструктурированного текста с использованием documenttils
Я бы хотел дословно извлечь исходный код из директив кода в виде строки с реструктурированным текстом. Далее следует моя первая попытка сделать это, но я хотел бы знать, есть ли лучший (то есть б
1ответ
4 голоса
Двойное предупреждение индекса при сборке сфинкса; Как включить файл без индексации его содержимого?
Я хочу создать файл single_html.rst, содержащий все мои class /method /attribute /etc ..., но также разделяет классифицированные символы на отдельные страницы. например. single_html.rst .. s
3ответа
4 голоса
Есть ли способ разбить слово на несколько строк в ячейке таблицы в reStructuredText, чтобы оно отображалось как одно слово в выводе?
Скажем, у меня есть таблица в reStructuredText как: +---------------+---------------------------+ | key | value | +===============+===========================+ | shor
1ответ
4 голоса
Почему математические формулы не отображаются в Sphinx /pythonhosted.org?
Я не уверен, где именно проблема.Я разработал пакет Python под названием ---- +: = 0 =: + ----, который размещает свою документацию на pythonhosted.org (официальном сайте, где его автоматически размещ
2ответа
4 голоса
Как сделать ссылку на корневую страницу в intersphinx
Я включил ---- +: = 0 =: + ---- в моем проекте и добавил следующую конфигурацию:У меня есть следующее в моем ---- +: = 2 =: + ---- :Я хотел бы, чтобы ссылка указывала на ---- +: = 4 =: + ---- , корнев
3ответа
5 голосов
Как конвертировать документы ReStructuredText в записные книжки ipython?
В наши дни много документации в сообществе python написано в ReStructuredText. Я хочу преобразовать некоторые из этих документов в записные книжки ipython, чтобы можно было не просто читать примеры
1ответ
5 голосов
Как создать табличный вывод в reStructuredText без использования формата таблицы RST?
Я пытаюсь перенести наши документы API и их собственную схему генератора документации в reStructuredText. Самое трудное время в том, что у нас есть табличное представление деталей API, закодированны
1ответ
6 голосов
Сфинкс: индексированная ссылка
Как я могу сделать перекрестную ссылку на индексированный элемент внутри документа reStructuredText? Например, как я могу сделать перекрестную ссылку на SectionB: .. index:: pair: SectionA;
2ответа
6 голосов
Как добавить теги стиля блога в reStructuredText с помощью Sphinx
Для проекта документации по языку программирования, написанного в reStructuredText и представленного в HTML с помощью Sphinx, я хочу сгруппировать свои функции в логические группы, такие как: String
6ответов
7 голосов
Подсветка встроенного кода сфинкса
Я использую Sphinx, чтобы создать сайт, содержащий примеры кода. Я успешно использую директиву .. code-block, чтобы получить подсветку синтаксиса. Но я не могу получить подсветку встроенного синтакс
3ответа
9 голосов
Как преобразовать презентацию S5 в PDF?
Я использую reStructuredText & rst2s5 для создания S5 Слайд-презентации. Это здорово, но я также хочу иметь презентацию в формате PDF. Как я могу конвертировать S5 в PDF? S5 основаны на
1ответ
10 голосов
строка документации Python rtype /реструктурированный текст для фабрики классов /селекторов
: rtype: указывает, что это тип возвращаемого объекта Поэтому, когда я создаю объект obj в следующем фрагменте, я получаю предупреждение от IDE, что cls is not callable, поскольку в среде IDE ожид
1ответ
10 голосов
Предотвращение вложенности подразделов в Python Sphinx при использовании toctree
Я столкнулся с проблемой при структурировании моего руководства пользователя Sphinx. Я хотел бы сформировать главу, имея главную целевую страницу (index.rst), которая содержит заголовок главы и обзо
2ответа
11 голосов
В reStructuredText, как поместить встроенный литерал внутри гиперссылки?
В моем документе reStructuredText у меня есть раздел, определенный следующим образом: Update the ``PATH`` Environment Variable ---------------------------------------- Я бы хотел добавить ссылк
1ответ
13 голосов
Как создавать пользовательские директивы в Sphinx
В настоящее время я документирую API отдыха, написанный на Python. Вся документация проекта создается с использованием Sphinx, и для REST API я хотел бы создать несколько специальных директив. Напри
4ответа
18 голосов
Рабочий пример плавающего изображения в реструктурированном тексте
Я ищу лучший способ, чтобы изображение с текстом, появляющимся рядом с ним в реструктурированном тексте. Я нашел несколько сайтов, нацеленных на то, чтобы показать, как это делается, но ни один из н
4ответа
18 голосов
Замены внутри ссылок в reST /Sphinx
Я использую Sphinx для документирования веб-сервиса, который будет развернут на разных серверах. Документация полна примеров URL, по которым пользователь может щелкнуть, и они должны просто работать
3ответа
18 голосов
Как сделать внутреннюю ссылку на заголовок в sphinx restructuredtext без создания произвольных меток?
У меня есть документ со многими заголовками и подзаголовками. Далее в тексте я хочу сослаться на один из заголовков. Как я могу сделать это без избыточности меток :ref:? Кажется, что содержимое отлич
1 2

Популярные теги

security × 330linux × 316macos × 2827 × 268performance × 244command-line × 241sql-server × 235joomla-3.x × 222java × 189c++ × 186windows × 180cisco × 168bash × 158c# × 142gmail × 139arduino-uno × 139javascript × 134ssh × 133seo × 132mysql × 132