1
ответ
Как сохранить разрывы строк при создании документов Python с помощью sphinx
Я использую Sphinx для создания документов для Python проект.
Выходной html не сохраняет разрывы строк, которые присутствуют в строке документации.
Пример: Код def testMethod (arg1, arg2): "" "...
вопрос задан: 18 November 2015 22:11
1
ответ
Подключить Sphinx autodoc-skip-member к моей функции
Я хочу использовать событие sphinx autodoc-skip-member для выбора части членов в определенном классе Python для документации. Но это не ясно из документации sphinx, и я не могу найти никаких примеров ...
вопрос задан: 15 May 2015 21:29
1
ответ
Для sphinx autosummary, как вы используете параметр: toctree: option? [Дубликат]
Поэтому в документации Sphinx говорится: «Если вы хотите, чтобы автозаполнение таблицы также использовалась как запись в тексте, используйте опцию toctree» - .. autosummary ::: toctree: DIRNAME sphinx.environment ....
вопрос задан: 8 December 2014 13:27
1
ответ
Добавление аннотаций в тексте в тексте toctree [duplicate]
Я хочу добавить группировку в модули / другие .rst-файлы, включенные в toctree, чтобы лучше объяснить документацию. Например, перечисленные ниже файлы сгруппированы в 3 части: Содержание: ...
вопрос задан: 2 August 2014 02:40
1
ответ
Как связать с функцией чтения с автомодулем в Sphinx [duplicate]
Я прочитал в модуле (например, func.py) функцию автомодуля в Sphinx. func.py может выглядеть так, как def funca (arg1): «" Docstring funca "" "return arg1 def funcb (arg2)" "" ...
вопрос задан: 28 March 2014 04:32
1
ответ
Сфинкс, reStructuredText показывают/скрывают фрагменты кода
Я документировал пакет программного обеспечения с помощью Сфинкса и reStructuredText. В рамках моих документов существуют некоторые длинные фрагменты кода. Я хочу смочь иметь их скрытый как значение по умолчанию, с немного "...
вопрос задан: 16 March 2013 12:38
1
ответ
Сфинкс - генерирует автоматические ссылки на билеты Trac и changesets
Сфинкс, там путь к автоматически тексту ссылки как № 112 или r1023 к соответствующему tickets/changesets в Trac? Для, например: № 112-> http://mytracsite/tickets/112 r1023-> http://mytracsite/...
вопрос задан: 11 February 2013 22:05
1
ответ
Замены в кодовых блоках Sphinx
В этом примере reST, предназначенном для визуализации с помощью Sphinx, | yaco_url | не заменяется, потому что находится в блоке кода: .. | yaco_url | replace :: http://yaco.es/ Вы можете использовать wget для его загрузки: .. code -...
вопрос задан: 17 January 2012 16:48
1
ответ
Миграция от Javadoc до документации Python
Таким образом, я стал несколько привыкшим к документации стиля Javadoc. Просматривая различные примеры кода Python, я нахожу, что на первый взгляд документация, кажется, пропускает много из...
вопрос задан: 18 July 2011 18:02
1
ответ
Используя RestructuredText и Сфинкса для включения предварительно отформатированного файла
Я пытаюсь заставить этот фрагмент работать: История версий---------------Это версии со временем::.. включайте:: ../../CHANGES.txt таким образом, используйте включать директиву так, чтобы файл был...
вопрос задан: 18 July 2011 18:00
1
ответ
Сфинкс: перекрестно сошлитесь на индексированный объект
Как я могу перекрестно сослаться на индексируемый объект в reStructuredText документе? Например, как может я перекрестно ссылаться на SectionB:.. индекс:: пара: SectionA; SectionB SectionB--------SectionB...
вопрос задан: 18 July 2011 17:58
1
ответ
Изображения в замечаниях/предупреждениях/уведомлениях
Я в настоящее время использую Сфинкса для генерации ЛАТЕКСНОГО вывода, который превращен в PDF для вывода книжного стиля с помощью pdftex. В настоящее время у меня есть уведомления, предупреждения и другие "замечания", обнаруживающиеся в огранич
вопрос задан: 18 July 2011 17:57
1
ответ
документация django, локально настраивающая
Я пытался установить django. У меня действительно есть Django-1.1-alpha-1. Я пытался сделать документацию, которая расположена при Django-1.1-alpha-1/doc использовании, делают утилиту. Но я получаю некоторую ошибку при высказывании...
вопрос задан: 18 July 2011 17:25
1
ответ
Ссылки на цифры с номерами в Sphinx и reStructuredText
При написании RST, который будет обрабатываться с помощью Sphinx, я не могу получить вывод Sphinx LaTeX для использования номеров фигур при ссылках на цифры. Например, этот код: лемминги атакуют, как может быть ...
вопрос задан: 18 July 2011 17:13
1
ответ
Как загрузить документацию HTML, сгенерированную от сфинкса к GitHub?
Я просто зарегистрировал загрузки своего кода и изучил, как использовать сфинкса для генерации документации. Я хочу включать это в свою страницу проекта GitHub, но я не знаю как к. Делает любой знает существующий...
вопрос задан: 18 July 2011 17:04
1
ответ
Условный вывод в Документации Сфинкса
Я пишу, что некоторая документация со Сфинксом и хотел бы распечатать определенный блок текста только для документации HTML, не для ЛАТЕКСНОЙ документации. Что-то мне подсказывает, что я должен смочь сделать это...
вопрос задан: 18 July 2011 13:22
1
ответ
покажите *только* docstring в документации Сфинкса
У сфинкса есть функция, названная автометодом, который извлекает документацию из docstring метода и встраивает это в документацию. Но это не только встраивает docstring, но также и метод...
вопрос задан: 18 July 2011 13:21
1
ответ
Что корректный путь к документу a ** kwargs параметр?
Я использую сфинкса и плагин автодокумента для генерации документации API для моих модулей Python. Пока я вижу, как приятно зарегистрировать определенные параметры, я не могу найти пример того, как зарегистрировать...
вопрос задан: 18 July 2011 13:16
1
ответ
Существует ли путь в Sphinx/Pygments, чтобы подчеркнуть, что одна или несколько строк кода в литерале включают?
В некоторых документах сфинкса я пишу, я включаю примеры кода из вспомогательного файла как так:.. literalinclude:: mymodule.py: pyobject: MyClass: linenos: Этот конкретный документ является учебным руководством...
вопрос задан: 18 July 2011 13:13
1
ответ
То, как делают я отключаю, раскрашивает ЛАТЕКСНЫЙ вывод, сгенерированный от сфинкса?
Когда я создаю ЛАТЕКСНЫЙ файл, сгенерированный из сфинкса, Элементов оглавления, и разделяю заголовки, являются синими. Существует ли простой способ отключить окраску этих объектов? В противном случае есть ли простой способ сделать их...
вопрос задан: 18 July 2011 13:13
1
ответ
Используя сфинкса, чтобы автозарегистрировать класс Python, модуль
Я установил Сфинкса для документирования некоторых модулей Python и класса, я продолжаю работать. В то время как язык разметки выглядит очень хорошим, мне не удалось автозарегистрировать код Python. В основном, я...
вопрос задан: 18 July 2011 12:58
1
ответ
Используя сфинкса со Скидкой с цены вместо RST
Я ненавижу RST, но люблю сфинкса. Существует ли способ, которым сфинкс читает скидку с цены вместо reStructuredText?
вопрос задан: 18 July 2011 01:57
1
ответ
Каковы отношения между docutils и Сфинксом?
Кажется, существует множество инструментов документации для Python. Другой, что я натыкался, является epydoc. Кажется, что Сфинкс является фактическим стандартом, потому что это используется для генерации чиновника...
вопрос задан: 22 April 2011 16:56
1
ответ
Сфинкс для php кодирует [закрытую] документацию
Сфинкс является библиотекой Python для генерации хорошей документации от ряда файлов форматированного текста ReST. Не инструмент использовал для полнотекстового поиска, я также полностью осведомлен о doxygen / phpdoc инструменты. Я...
вопрос задан: 5 January 2011 14:22
0
ответов
Может ли sphinx ссылаться на документы, которые не расположены в каталогах ниже корневого документа?
Я использую Sphinx для документирования проекта, не-Python. Я хочу распределить папки./doc в каждом подмодуле, содержащие файлы submodule_name.rst для документирования этого модуля. Затем я хочу высосать эти файлы...
вопрос задан: 13 August 2019 15:58
0
ответов
Ошибка сфинкса: автодоку не удалось импортировать модуль
Я хочу создать строку документации для моего проекта с именем "sortingalgorithm.py". Я настраиваю сфинкса. Я установил пакет sphinx и запустил быстрый запуск. Затем, когда я хочу "сделать HTML" и когда я начал это ...
вопрос задан: 29 March 2019 09:59
0
ответов
Настройка сборки темы документа на сайте readthedocs
ReadTheDocs.org - это действительно отличный способ опубликовать html, сгенерированный сфинксом, но есть несколько незначительных проблем, связанных с темой, которые я предпочел бы решать по-другому Прочитав кучу ...
вопрос задан: 19 March 2019 15:22
0
ответов
sphinx показывает ошибку: невозможно создать процесс
Я использую Sphinx под python3 в Windows. Раньше у меня это работало: использовали sphinx-quickstart и sphinx-apidoc для генерации html. Теперь он показывает ошибку не удалось создать процесс, как это: перейти к ...
вопрос задан: 19 March 2019 05:25
0
ответов
Sphinx :Список поддерживаемых языков для выделения?
Я использую Sphinx для документации кода и использую несколько языков в коде, я хотел бы настроить подсветку для всего этого кода. Sphinx кратко упоминает несколько поддерживаемых им языков (...
вопрос задан: 2 February 2019 00:40
0
ответов
RST + Sphinx: Как настроить поиск, чтобы он работал по-другому?
У меня есть проект документации с использованием sphinx. У меня есть два вопроса относительно поведения поиска: Вопрос 1: Когда я ищу что-то в документах, я получаю первый вывод. Как я могу предотвратить это и ...
вопрос задан: 18 January 2019 09:58