Вопросы по теме 'restructuredtext'
Можно ли писать в реструктурированном тексте в две колонки?
Я хотел бы написать исследовательскую работу с использованием реструктурированного текста, возможно ли иметь стиль с двумя столбцами, присущий этому типу документа? Я просмотрел спецификации , но отдельно использовал таблицу, которая будет...
3983 просмотров
schedule
11.07.2022
Внешняя документация по PHP, без DocBook
Мне нужна система документации для проекта PHP, и я хотел, чтобы она могла интегрировать внешнюю документацию (варианты использования, объем проекта и т. д.) с документацией, созданной из комментариев к коду. Кажется, что phpDocumentor имеет именно...
839 просмотров
schedule
23.08.2022
Вставить относительную ссылку в reStructuredText
Я документирую библиотеку, в которой есть компонент Python и компонент JavaScript. Общая пользовательская документация и документация API Python находятся в reStructuredText, обработанном с помощью Sphinx. JavaScript API находится в jsdoc и...
7789 просмотров
schedule
11.03.2023
Как написать файлы readme, которые автоматически включаются в вывод Doxygen?
Концептуально в духе реструктурированного текста я хочу распределить файлы readme по разным исходным каталогам, а затем попросите Doxygen прочитать и включить эти текстовые файлы readme как часть сгенерированного вывода Doxygen.
Как это...
2078 просмотров
schedule
03.05.2024
Как добавить лишний пробел между заголовком раздела и абзацем
Я хочу, чтобы между заголовком и абзацем было больше места, а также между абзацами. Я не хочу, чтобы это была глобальная настройка, но я хочу использовать ее где и когда необходимо. Ценю любые предложения.
5332 просмотров
schedule
12.03.2022
Рабочий процесс документации Sphinx и JavaScript [закрыт]
Для моего JavaScript-фреймворка я хотел бы использовать Sphinx. Поскольку я новичок в мире Sphinx, я бы хотел, чтобы вы помогли мне начать работу со Sphinx и JavaScript.
4739 просмотров
schedule
01.11.2022
Возможности шаблона docutils/reStructuredText
Как я могу настроить заполнители в моем файле .rst с фактическими значениями?
Например, у меня есть файл example.rst со следующим содержимым:
Header
------------------------------------
${custom_text}
Я хочу заменить свойство...
2608 просмотров
schedule
04.03.2022
Сетка изображения в reStructuredText / Sphinx
Я использую Sphinx для создания документации для проекта Python, над которым я работаю. У меня есть три изображения, которые я хотел бы отобразить в сетке 1x3 (т.е. все в одной строке), и я пытаюсь понять, как это сделать в reStructuredText. Прямо...
10609 просмотров
schedule
30.09.2022
Встроенные и многострочные уравнения не работают
Я пытаюсь написать некоторые уравнения в системе документации Sphinx Python. Я пытался заставить работать следующее многострочное уравнение:
.. math::
P_{Survival} (L) = P_{S} (L) = exp \{ - \frac{ \sigma (E) \rho L}{m_{T}} \}...
381 просмотров
schedule
17.12.2022
Связывание с фигурами в Sphinx
В моей документации есть несколько изображений, созданных в виде набора файлов reST в Sphinx. Я предпочитаю, чтобы они были довольно маленькими, и я хочу, чтобы пользователь нажимал на них, чтобы получить увеличенное изображение. Меньшее изображение...
1565 просмотров
schedule
05.05.2023
Как обрабатывать два тире в ReST
Я использую Sphinx для документирования утилиты командной строки, написанной на Python. Я хочу иметь возможность задокументировать параметр командной строки, например --region , например:
**--region** <region_name>
в ReST, а затем...
3167 просмотров
schedule
07.11.2023
Как искать китайские иероглифы и короткие слова в документации, созданной Sphinx?
apt-get install python-sphinx
apt-get install sphinxsearch
mkdir rest
cd rest/
sphinx-quickstart
я создаю свою первую статью в реструктурированном тексте. http://s.yunio.com/!LrAsu
Пожалуйста, загрузите его и...
1304 просмотров
schedule
19.11.2022
Sphinx restructuredText для преобразования гиперссылки в HTML
У меня есть коллекция файлов reStructuredText, которые связаны друг с другом следующим образом:
further reading at `document name <otherdoc.rst>`.
Я заметил, что это очень хорошо работает на BitBucket и Github, поскольку файлы .rst...
816 просмотров
schedule
12.05.2022
разобрать reStructuredText README.rst, чтобы получить раздел описания
Я пытаюсь повторно использовать информацию из моего README.rst в описании пакета setup.py.
В моем setup.py у меня есть функция readme:
def readme():
try:
with open(os.path.join(os.path.dirname(__file__), 'README.rst')) as f:...
680 просмотров
schedule
24.09.2023
Можно ли сделать так, чтобы автоматическая нумерация заголовков разделов в reST начиналась с уровня подраздела?
Можно ли как-то заставить reST начать нумерацию разделов только, скажем, второго уровня? Я использую настройку автоматической нумерации:
.. section-numbering::
Что я хотел бы для ввода:
Section A
=========
Subsection A.1
------------...
487 просмотров
schedule
24.09.2022
Как конвертировать документы ReStructuredText в блокноты ipython?
В наши дни большая часть документации в сообществе Python написана на ReStructuredText. Я хочу преобразовать некоторые из этих документов в блокноты ipython, чтобы можно было не только читать примеры в документах, но и сразу взаимодействовать с ними....
1280 просмотров
schedule
11.06.2023
Sphinx удалить заголовок главы в моем PDF-файле с помощью latexpdf?
Я создаю документацию из первого в pdf с помощью latexpdf и sphinx.
Как я могу удалить заголовок главы перед каждой главой?
-----------
CHAPTER ONE
-----------
3229 просмотров
schedule
21.03.2023
Как исправить ширину столбца в таблицах reStructuredText?
Я использую Sphinx для создания этой таблицы:
+---------------+---------------------+---------------------------+-------------------------------------+---------------------+
| Stakeholder | Major Value | Attitudes |...
2978 просмотров
schedule
03.03.2022
Проблема с форматом PyPI README.rst
У меня есть пакет Python. Я добавил файл README.rst для отображения описания. Он правильно отображается в GitHub .
Однако в PyPI мой файл RST не отформатирован; он отображает необработанный контент.
Вы можете найти файл setup.py здесь...
438 просмотров
schedule
03.05.2023
включить подсветку синтаксиса уценки в комментариях/документах кода
Существуют отличные стандарты документации в коде для python, например:
Google
Numpy
Которые используют хороший, простой синтаксис ReStructured/Markdown. Есть ли способ заставить emacs визуализировать ReST / Md внутри комментариев...
269 просмотров
schedule
30.12.2022
