Описание тега sphinx-napoleon
Napoleon is an extension for the Sphinx documentation generator, which adds support for Google and NumPy docstrings.
1
ответ
Как автоматически добавлять типы параметров в документацию sphinx
В настоящее время я пытаюсь реализовать автоматическое создание документации с помощью Sphinx (используя расширения sphinx-apidoc и napoleon). Это работает довольно хорошо, но было бы еще лучше, если бы шрифты (соглашение PEP484) автоматически добав…
28 мар '18 в 17:23
4
ответа
Документирование атрибутов класса с аннотациями типов
Я хочу автоматически сгенерировать документацию для моего кода из строк документации. У меня есть базовый класс, предназначенный для хранения некоторых данных: class DataHolder: """ Class to hold some data Attributes: batch: Run without GUI debug (b…
26 май '18 в 19:03
0
ответов
Короче ссылки между сфинксами?
Я стараюсь, чтобы мои строки документов были читаемыми, и мне тяжело с интерсфинксом и Наполеоном. У меня есть такой класс: from long_import_path_one.long_import_path_two import Bar from long_import_path_one.long_import_path_three import Baz from lo…
15 ноя '18 в 17:33
2
ответа
Простой способ конвертировать строки документации Python из реструктурированного текста в стиль Google?
Кто-нибудь теперь простой способ конвертировать все строки документации в существующем проекте из reStructured Text в формат Google? Похоже, что Наполеон может сделать что-то подобное, но это выглядит очень сложно, поэтому я решил спросить, делал ли…
06 июл '17 в 17:22
4
ответа
Может ли sphinx наполеон документировать функцию, возвращающую несколько аргументов?
Я пытаюсь использовать стиль кода Google для документирования функции, для которой я затем использую sphinx с расширением napoleon для создания документации. Функция необычна тем, что возвращает два аргумента. Я не думаю, что Наполеон справится с эт…
23 мар '15 в 22:21
0
ответов
Каким образом документация Pandas обеспечивает "выделение серым цветом поля" параметр "и" возврат ""?
Глядя на следующий код из github, я вижу css, которые делают это возможным: /* grey highlighting of 'parameter' and 'returns' field */ table.field-list { border-collapse: separate; border-spacing: 10px; margin-left: 1px; /* border-left: 5px solid rg…
28 июн '17 в 15:35
1
ответ
Пример строки документа в стиле Google не отображается как фрагмент кода
Недавно я начал добавлять документацию в свой проект, и я пытаюсь следовать руководству по стилю Google. Я использую Sphinx для генерации документов и расширение Sphinx для преодоления разрыва между Google style guide и reST. У меня нет проблем с ре…
15 июн '17 в 21:31
1
ответ
Можно ли иметь список параметров в sphinx.ext.napoleon?
Я использую расширение autodoc sphinx вместе с sphinx.ext.napoleon. Я следую руководству по стилю numpydoc, так как считаю его более читабельным, чем руководство Google. Однако я заметил следующую проблему, которую не смог исправить. У меня следующи…
24 окт '17 в 15:05
0
ответов
Какой-то способ отключить автоматическую перекрестную ссылку на имена атрибутов в ivar
При использовании Napoleon с Google Docstrings (я не проверял NumPy, но я подозреваю, аналогичные проблемы) с napoleon_use_ivar опция установлена в Trueсоздает ссылки на имена переменных экземпляра. Эти имена, очевидно, очень распространены (такие…
14 дек '16 в 14:55
0
ответов
Документация Sphinx, как включить информацию из другой строки документации
Привет у меня есть функция с псевдонимом (я не знаю, если это технический термин) в методе класса, что-то вроде этого: def foo(p_1,p_2): """this foos the bar Long detailed docsting """ return p_1+p_2 class bar(): def foo(self, p_2): """this also foo…
06 фев '19 в 22:43
1
ответ
Как правильно добавить вложенный список в numy docstring в сочетании с sphinx docstring
Мне интересно, как я могу добиться следующего. Я использую простой стиль docstring в сочетании с autodoc sphinx для создания автоматической документации. Тем не менее, я изо всех сил в наличии вложенного списка в выводе: Attributes ---------- attrib…
19 сен '17 в 15:28
1
ответ
Сфинкс не работает при создании документации для проекта Django
Я пытаюсь автоматически сгенерировать документацию для моего проекта Django, используя Sphinx с расширениями autodoc и napoleon. С помощью sphinx-quickstart Я создал следующую структуру: MyDjangoProject ├── __init__.py ├── config │ ├── __init__.py │…
25 янв '17 в 13:43
2
ответа
Список методов класса с расширением Napoleon Sphinx в стиле NumPyDoc
Я использую строки документации в стиле NumPyDoc для документирования пакета Python. Я хотел бы перейти от расширения Sphinx 'numpydoc' к Napoleon, потому что я считаю, что оно форматирует строку документации более компактным и читаемым способом. Те…
20 янв '17 в 11:25
4
ответа
Заставить sphinx интерпретировать уценку в строках документов Python вместо реструктурированного текста
Я использую Sphinx для документирования проекта Python. Я хотел бы использовать Markdown в моих строках документов для их форматирования. Даже если я использую recommonmark расширение, оно охватывает только .md файлы, написанные вручную, а не строки…
09 май '19 в 15:04
1
ответ
Как получить такой же вывод из документов sphinx napoleon и numpy style, как при первом способе по умолчанию?
Если я возьму очень простой файл Python: def magic_function(parameter1): """ Do magic with parameter1. :param parameter1: The first of all paramters :type parameter1: nd_array """ return parameter1 Я получаю тип сразу после параметра: Если я сейчас …
16 июн '19 в 19:46
0
ответов
Как использовать Sphinx и autosummary для создания таблицы функций для каждого модуля Python
У меня есть пакет Python, состоящий из ряда модулей, которые, в свою очередь, содержат функции (... без классов). У меня был большой успех со Sphinx и autodoc / napoleon. У меня есть отдельный.rst для каждого модуля и оглавление, которое позволяет м…
31 мар '20 в 21:47
1
ответ
Вставить изображение в сфинкса с помощью препроцессора наполеона
Используя sphinx 3.1.1, я хочу вставить изображение с помощью препроцессора Наполеона. Кажется, что наличие команды: ".. image::" в строке документации предотвращает предварительную интерпретацию с помощью препроцессора Наполеона, а строка документа…
01 июл '20 в 15:06
1
ответ
Базовый синтаксис комментариев и строк документации в коде Python
Я учусь использовать Sphinx для создания документации по своему коду. После того, как я увидел несколько таких примеров: def complex(real=0.0, imag=0.0): """Form a complex number. Keyword arguments: real -- the real part (default 0.0) imag -- the im…
24 июн '20 в 01:58
2
ответа
Пропуск подсказок по типу в документации
Рассмотрим следующую функцию: def f(x: int, y: int) -> int: """Get sum of two integers. Parameters ---------- x : int first integer y : int second integer Returns ------- int sum of the provided integers """ return x + y При документировании с по…
21 авг '20 в 10:47
1
ответ
Следует ли мне задокументировать параметры для аналогичных сигнатур функций?
У меня есть несколько вспомогательных функций, которые, за исключением первого аргумента, принимают те же аргументы, что и основная функция. Параметры тщательно задокументированы в основной функции. Следует ли мне скопировать и вставить эту документ…
08 июн '20 в 11:58