0
ответов
как показать атрибуты экземпляра в sphinx doc?
Есть ли способ, как автоматически показывать переменные var1 и var2 и их значения инициализации в документации sphinx? class MyClass: "" "Описание класса" "" def __init __ (self, ...
вопрос задан: 18 January 2019 01:11
0
ответов
Импортировать модуль sphinx в python
Я хотел бы разместить на флеш-сервере HTML-страницу с reStructuredText с использованием темы sphinx readthedocs, визуализированной на лету из первого файла. Как я могу импортировать sphinx как модуль python, и ...
вопрос задан: 17 January 2019 09:42
0
ответов
Невозможно импортировать строку документации класса init на сайт, используя sphinx
Я создал пользовательские классы. Мои файлы Python имеют несколько классов в следующем формате. class First (): def __init __ (arg1, arg2, arg3 ....): arg1 = arg1 arg2 = arg2 и т. д. "" ": arg1: ...
вопрос задан: 16 January 2019 10:32
0
ответов
Создание роли coderef для sphinx
Вопрос: Я хочу создать роль coderef, которая будет ссылаться на код модуля с слитками, созданный sphinx.ext.viewcode. Для этого у меня сложилось впечатление, что мне нужно заполнить env._viewcode_modules ...
вопрос задан: 31 December 2018 14:26
0
ответов
Как создать индекс Sphinx из определенного или пользовательского элемента docstring?
Можно ли создать индекс в Sphinx, который создается конкретными (или настраиваемыми) элементами в docstring? Например, у меня есть следующая функция и хотелось бы, чтобы Sphinx создал ...
вопрос задан: 13 July 2018 06:36
0
ответов
Как сгенерировать табличный вывод в reStructuredText без использования формата таблицы RST?
Я пытаюсь перенести наши документы API и их собственную схему генератора документации в reStructuredText. Сложнее всего то, что у нас есть табличное представление деталей API, ...
вопрос задан: 12 February 2018 19:45
0
ответов
Mysql select distinct
Я пытаюсь выбрать одну из повторяющихся строк в таблице mysql, но проблема в том, что она не позволяет мне выбрать все поля в этом запросе, просто позволяя мне выбрать поле...
вопрос задан: 18 January 2018 21:35
0
ответов
Какие файлы я должен указать моей VCS игнорировать при использовании Sphinx для документации ? [закрыто]
Я хочу начать использовать Sphinx для документирования моего проекта. Я сказал Sphinx использовать отдельные каталоги исходного кода и сборки во время sphinx-quickstart. Теперь мой макет каталога следующий: MyProject / ...
вопрос задан: 18 June 2017 15:30
0
ответов
Включение строки документации в документацию Sphinx
Я хотел бы включить только строку документации определенной функции в мою документацию Sphinx. Однако, похоже, нет возможности просто отобразить эти детали без ассоциированного класса и функции ...
вопрос задан: 23 May 2017 12:24
0
ответов
Как показать и скрыть код в документе sphinx?
Я хочу, чтобы та же функциональность упоминалась в Sphinx, reStructuredText показывает / скрывает фрагменты кода. Но в этом посте нет кода.
вопрос задан: 23 May 2017 12:24
0
ответов
Как управлять несколькими версиями документации с помощью Sphinx? [закрыто]
Я поддерживаю небольшой проект библиотеки, написанный на C ++.
Я хотел бы использовать Sphinx для поддержки веб-сайта библиотеки + пользовательской документации для каждой версии выпуска. Я нашел [подобный вопрос задан Как управлять ...
вопрос задан: 23 May 2017 12:17
0
ответов
Как создать глобальную роль/роли в Sphinx?
Это продолжение зачеркнутого ReST «ReST Strikethrough», но в контексте Sphinx, а не ReST. Мой вопрос заключается в том, есть ли в sphinx центральное место, куда можно поместить директиву «роль», или…
вопрос задан: 23 May 2017 11:54
0
ответов
Почему CPython не использует 'sphinx.autodoc' для стандартной библиотеки? [закрыто]
Я разрабатываю библиотеку Python и использую sphinx.autodoc для создания документации, так как считаю, что это хороший способ не повторяться и согласовать документацию и код....
вопрос задан: 23 May 2017 11:51
0
ответов
Как правильно выровнять контент столбцов в реструктуренных текстах простых таблиц?
Я редактирую документацию для проекта шахты с помощью SPHINX, который, в свою очередь, использует реструктурныйтекст как язык разметки. У меня есть простая таблица (в отличие от таблицы сетки), в котором самый правый ...
вопрос задан: 22 March 2017 15:36
0
ответов
Форматирование сплавов сфинх.
Я использую SPHINX для генерации документации из кода. Кто-нибудь знает, есть ли способ контролировать форматирование номеров плавающих точек, создаваемых из аргументов по умолчанию. Например, если у меня есть ...
вопрос задан: 1 January 2017 15:50
0
ответов
Перезапуск приложения в Eclipse
Есть ли способ перезапустить программу в Eclipse? (желательно 1 щелчок) Я действительно хочу, чтобы в представлении консоли было что-то вроде кнопки перезапуска, которая убивала бы приложение и перезапускала его с последней ...
вопрос задан: 8 June 2016 17:17
0
ответов
Как заставить Sphinx использовать интерпретатор Python 3.x
Я пытаюсь создать документацию для проекта, написанного с помощью Python 3.x. Sphinx - это инструмент, который я хочу использовать, и, согласно официальному сайту, его последняя версия 1.1.2 совместима с Python 3.1+. Моя ОС ...
вопрос задан: 5 June 2016 13:31
0
ответов
Как я могу сделать гиперссылку на метод из модуля Python в Sphinx?
Когда я пишу документацию с помощью Sphinx, я знаю, что могу связать класс с помощью Intersphinx:: py: class: `logging.Logger` Но как мне связать напрямую с конкретным методом, например logging.Logger. ...
вопрос задан: 27 September 2015 20:24
0
ответов
Как вывести значение конфигурации в файл Sphinx .rst?
В conf.py у меня есть следующее: def setup(app): app.add_config_value('base_url','http://localhost:2000', True) Как мне поместить это в мои файлы .rst ? Я написал это: :base_url:/my_app/api/...
вопрос задан: 13 July 2015 14:57
0
ответов
Sphinx autodoc выдает ПРЕДУПРЕЖДЕНИЕ :py :цель ссылки на класс не найдена :тип предупреждения
У меня есть код, который использует метакласс в python. Но когда запускается sphinx autodoc, он выдает ошибку :WARNING :py :class reference target not found :type Ошибка возникает в строке...
вопрос задан: 9 May 2015 14:28
0
ответов
Могу ли я добавить весь пакет (рекурсивно) в индекс в генераторе документов Sphinx?
Я хочу создать документацию для своего пакета. Каждый файл в проекте содержит обширную документацию. Есть ли способ быстро добавить весь мой проект в индекс документации? Я хотел бы ...
вопрос задан: 15 April 2015 09:34
0
ответов
Как добавить дополнительные пробелы между заголовком раздела и абзацем
Я хочу, чтобы между заголовком и абзацем было больше места абзац и между абзацами. Я не хочу, чтобы это был глобальный параметр, но я хочу использовать его там и тогда, когда это необходимо. Примите во внимание любое ...
вопрос задан: 17 March 2015 17:29
0
ответов
Сделать Read Docs включающим документацию autodoc для специальных пользователей?
У меня есть модуль с двумя задокументированными глобальными специальными членами. Запуск Sphinx локально создает документацию, которая включает их документы, а Read the Docs - нет. Он использует документацию встроенного типа ...
вопрос задан: 17 January 2015 20:41
0
ответов
Как задокументировать параметры функции Python с помощью sphinx-apidoc
Я пытаюсь очистить документацию по коду Python и решил использовать sphinx-doc, потому что он выглядит хорошо. Мне нравится, как я могу ссылаться на другие классы и методы с помощью тегов вроде:: class: `mymodule ....
вопрос задан: 23 December 2014 23:34
0
ответов
Позвольте sphinx использовать версию из setup.py
Если я делаю sphinx-quickstart, меня спрашивают о версии проекта. Я хочу избежать двух мест для версии моего проекта. Как это сделать в мире упаковки Python?
вопрос задан: 1 October 2014 12:53
0
ответов
/ bb | [^ b] {2} / چگونه کار می کند؟ [بسته]
کسی لطفاً توضیح دهد؟ من این را روی یک تی شرت خواندم: به نظر می رسد که می گوید: "بودن یا نبودن" چگونه؟ به نظر نمی رسد که "e" را پیدا کنم؟ : p دقیقاً چگونه این regex techy / geeky است؟
вопрос задан: 20 May 2014 11:13
0
ответов
Полужирный курсив в ReStructuredText
Я пишу некоторую документацию, используя формат ReStructuredText (ReST) для последующего создания веб-страниц с использованием Sphinx, и я не могу найти способ написать какой-нибудь текст с «полужирным курсивом». Есть маркеры для ...
вопрос задан: 5 May 2014 19:05
0
ответов
sphinx.ext.autodoc: Сохранение имен констант в сигнатуре
Я использую функцию autodoc Sphinx для документирования моего API. Пример: DEFAULT_OPTION = 'default'
def do_something (msg, option = DEFAULT_OPTION): print msg Теперь сгенерированная документация показывает ...
вопрос задан: 17 November 2013 15:52
0
ответов
Как я могу сослаться на раздел страницы в сфинксе
У меня есть .. toctree как часть страницы sphinx, которая включает относительные ссылки на другие первые файлы в моем пакете. Как я могу включить ссылку на подраздел данной страницы, а не на всю страницу? ...
вопрос задан: 30 October 2013 15:24
0
ответов
Как изменить размер шрифта примера кода в выводе LaTeX PDF с помощью sphinx?
Я считаю, что шрифт примера кода по умолчанию в PDF-файле, сгенерированном sphinx, слишком велик. Я пытался запачкать руки в сгенерированном файле .tex, вставляя команды размера шрифта, такие как \tiny, над ...
вопрос задан: 22 April 2013 23:40