Описание тега docutils

None Система обработки документов общего назначения, написанная на Python.
1 ответ

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

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

Как скачать документы с помощью Django?

Я хотел бы загрузить всю мою документацию, сделанную с документами в некотором формате (HTML, PDF и т. Д.), Есть ли способ сделать это легко?
15 окт '15 в 01:30
1 ответ

Разбор reStructuredText в HTML

Я делаю фреймворк, в котором я позволяю разработчикам описывать свой пакет, используя reStructuredText. Я хочу разобрать этот reStructuredText в HTML, чтобы я мог показать его в графическом интерфейсе. Я знаком с отличным Сфинксом, но я никогда не а…
1 ответ

Как создать документацию для представления на основе классов?

В документации Django есть краткая информация о том, как документировать модели, представления и другие файлы, чтобы сделать их легко доступными в Django Admin. Но ему не хватает информации о том, как это сделать для представлений на основе классов.…
30 мар '17 в 07:51
2 ответа

Делать расширение сфинкса, которое складывает участки тела

Я пытаюсь сделать расширение в Sphinx, идея состоит в том, что расширение определяет заголовок разделов, а затем преобразует их в раздел сгиба, то есть сфинкс отображает заголовок с помощью кнопки префикса, которая помогает отображать или не отображ…
05 окт '15 в 17:04
1 ответ

Как аккуратно отформатировать код в HTML/CSS? Я особенно хочу использовать числовые выноски круга, с Python Docutils, если я могу

См.: http://diveintopython.net/native_data_types/lists.html У меня есть веб-сайт с примерами кода, созданный через docutilsи CSS всегда не совсем прав. Я хотел бы знать, если есть CSS наилучшей практики для отображения кода (т. е. может ли он обраба…
11 авг '11 в 14:07
1 ответ

Расширение первого контейнера для вывода дополнительных атрибутов div

Я начинаю использовать пеликан с reStructuredText rst формат страницы У меня есть пользовательские javascript (jQuery) вещи, которые я хотел бы контролировать с помощью атрибутов div, таких как data-default-tpl="basename" с вложенным контентом. Что …
23 май '14 в 08:37
3 ответа

:synopsis: не работает в автомодуле Sphinx

Я использую Sphinx, он мне очень нравится, но он не подберет краткий обзор модуля. Нет ошибок или чего-то еще, просто... ничего. Это модуль, который я пытаюсь автодокументы: # vim: set fileencoding=utf-8 : """ .. module:: CONF :synopsis: Configurati…
16 янв '13 в 14:53
1 ответ

Ошибка сфинкса в make html

Я пытаюсь создать документацию Sphinx для пакета, но продолжаю получать ошибки и могу использовать некоторую помощь. Мой каталог проектов bb_lite и коды расположены в backend папка. bb_lite ├── 1.0\ docs ├── 2.0\ data ├── README.md └── backend Вот т…
08 май '18 в 09:53
1 ответ

Невозможно запустить rst2html5slides после установки

Мы используем Powerpoint и Реструктурированный текст вместе с Python-Sphinx. Я спрашивал себя, возможно ли создавать слайды с помощью ReST. Я нашел интересный инструмент rst2html5slides на https://rst2html5slides.readthedocs.io/en/latest/index.html.…
1 ответ

Ссылка на CSV-таблицу как номер таблицы, а не имя таблицы

Я делаю документ со многими таблицами. Но единственный способ, которым я знаю, как ссылаться на них в тексте, заключается в :ref:'my_table' и это помещает полное имя таблицы "Длинный заголовок моей таблицы" в мой текстовый блок. Я бы предпочел помес…
15 дек '11 в 18:08
1 ответ

Присвоение имен / тегов переменных документу asciidoc, чтобы я мог использовать эти имена в шаблоне jinja

Мне нужен способ извлечь теги из файла Asciidoc и сохранить их в словаре Python. Я вообще пишу в Asciidoc но я не знаю, как я могу создать имена переменных в Asciidoc, которые я могу извлечь в качестве ключей для создания словаря Python. Я охотился …
21 июн '15 в 21:53
1 ответ

Как использовать documenttils для преобразования.rsts в htmls?

Я скачал утилиту (cmake, на самом деле) tar, и ее документ был записан в виде файлов.rst со структурой, подобной blow.После поиска в Google я знаю, что Docutils(пакет python) может конвертировать эти файлы в htmls, поэтому установил его, но я могу Н…
4 ответа

Django документы не работает

Я пытаюсь включить документацию для django в Windows 7. Я включил ссылки в файлах urls.y и settings.py, а также скачал и установил последний снимок документации. Однако каждый раз, когда я пытаюсь получить доступ к ссылке на документацию в админке, …
17 авг '11 в 09:25
2 ответа

Расширение сфинкса: буквальный блок с начальными и / или конечными пустыми строками?

Насколько я могу судить, невозможно создать буквенный текстовый блок (например, с code-block директива), которая начинается или заканчивается пустой строкой, потому что это было бы неоднозначно в отношении синтаксиса reStructuredText. Это нормально.…
1 ответ

Атрибут одиночного модуля Autodoc в Sphinx

Скажем, я задокументировал переменную в модуле Python, вот так: some_random_name = 'whatever' """The random whatever variable""" Могу ли я включить автодок для этой единственной переменной в мой файл.rst, не перетаскивая в модуль __doc__ строка и ге…
22 янв '13 в 16:21
1 ответ

Изображение с гиперссылкой в ​​reStructuredText

Я пытаюсь добавить изображение с внешней ссылкой. |facebook| |tw| .. |facebook| image:: http://www.summerbounce.ca/wp-content/uploads/2012/11/facebook-logo-small.png .. |tw| image:: http://www.summerbounce.ca/wp-content/uploads/2012/11/facebook-logo…
25 фев '13 в 15:51
1 ответ

Секционирование / группирование атрибутов внутри класса

У меня есть класс с большим количеством атрибутов; Я хотел бы представить их сгруппированными (а не в виде плоского списка) с видом, похожим на раздел, внутри документации класса. Это возможно с documenttils/sphinx? Любое предложение для достижения …
1 ответ

reStructuredText: как использовать строки продолжения в таблицах?

У меня есть следующий аккуратный столик в reStructuredText: ====== ======= ====== ===================== Symbol Meaning Type Example ====== ======= ====== ===================== G Era Text "GG" -> "AD" y Year Number "yy" -> "03" "yyyy" -> "20…
1 ответ

Вставьте директиву рисунка в таблицу в документах

Я пытаюсь сделать стол с какой-то фигурой внутри. Я спрашиваю, есть ли возможность сделать это в Docutils или на некоторых других языках разметки. Я пробовал этот вид таблицы: +-----------------+--------+--------------------------------------------+…
28 окт '14 в 11:21