Описание тега numpydoc
Numpydoc - это набор расширений для генератора документации Sphinx, он добавляет поддержку строк документации, отформатированных в соответствии с форматом документации NumPy.
0
ответов
numpydoc: документирование параметра типа утки
В соответствии с соглашением, приведенным в руководстве к документации numpy/scipy, параметры функции должны быть задокументированы следующим образом: def foo(x): """" This function does nothing Parameters ---------- x : type Description of paramete…
23 янв '14 в 18:16
0
ответов
Пользовательское расширение sphinx для создания списка методов класса
Я пытался создать расширение sphinx для генерации списка методов класса, всякий раз, когда класс документируется с использованием autodoc и добавляю его чуть ниже строки документации уровня класса (аналогично тому, что делает расширение numpydoc). Д…
24 июл '17 в 11:32
1
ответ
R означает что-то в сфинксе?
Я пишу мои строки документации, следуя руководству по Nummy Docstring. Затем я использую автодок sphinx для генерации моей документации. В некоторых документах я использую формулы LaTeX (sphinx.ext.mathjax). Кажется, что \r означает что-то особенное…
03 окт '17 в 11:10
1
ответ
Ошибка несуществующего документа в Sphinx
Я начал использовать Sphinx пару дней назад для документирования пакета Python, и я получаю то, что кажется обычной ошибкой, но я не могу найти решение для этого. Я использовал sphinx-quickstart, чтобы все настроить. Я использовал "doc/" для корнево…
19 июл '17 в 15:46
0
ответов
Списки маркеров после абзаца в Python Docstring иногда не работают со сфинксом и numpydoc
Документируя модуль Python с использованием стиля numpy и генерируя html-документацию с использованием sphinx и расширения numpydoc, я наткнулся на ошибку (или функцию?) В маркированных списках. In reStructuredText (and sphinx/numpydoc), a single-li…
13 июл '16 в 09:39
1
ответ
Проверьте соответствие кода и документации
Используя расширение Sphinx NumpyDoc, есть ли способ автоматически убедиться, что документация соответствует коду, который она документирует? Например, следующая документация не соответствует коду из-за опечатки: def myfunc(apples, bears): """ Param…
10 дек '16 в 02:45
0
ответов
Может ли py.test протестировать строку документации для стиля numpy?
Мой pytest.ini в настоящее время выглядит так: [pytest] addopts = --doctest-modules --cov=. --cov-report html --pep8 --flakes doctest_encoding = utf-8 Так что я уже тестирую на PEP8. Но я также хотел бы проверить строки документации для формата nump…
14 авг '17 в 11:33
1
ответ
Автодок Сфинкса ничего не импортирует?
Я пытаюсь использовать sphinx (в сочетании с autodoc а также numpydoc) для документирования моего модуля, но после базовой настройки make html производит только базовый html-файл без включенных строк документации. Я использую Python 3.3, структура п…
23 июл '14 в 08:23
0
ответов
Как правильно задокументировать свойства с NumpyDoc
Я управляю пакетом, который использует стиль NumpyDoc, и пытаюсь правильно задокументировать установщики / получатели некоторых свойств. В частности, у меня возникла проблема с тем фактом, что Python игнорирует документацию установщика, и, следовате…
19 фев '18 в 10:23
1
ответ
Ярлык в строке документации питона
Я использую sphinx autodoc, чтобы перевести мою строку документации на красивую страницу документации. В ленте документации я следую указаниям нуди, используя расширение "Наполеон Сфинкса". Я задаюсь вопросом о следующем: если у меня есть уравнение,…
03 окт '17 в 13:09
2
ответа
Можно ли скрыть аргументы функции Python в Sphinx?
Предположим, у меня есть следующая функция, задокументированная в стиле Numpydoc, и документация генерируется автоматически с помощью директивы автофункции Sphinx: def foo(x, y, _hidden_argument=None): """ Foo a bar. Parameters ---------- x: str The…
30 май '15 в 05:23
1
ответ
Может ли mypy проверить строки документов?
У меня есть строки документов в стиле numpydoc: def foobar(filename, copy, dtype, iterable, shape, files): """ foobar is 42. Parameters ---------- filename : str copy : bool dtype : data-type iterable : iterable object shape : int or tuple of int fi…
09 ноя '18 в 07:21
2
ответа
Список методов класса с расширением Napoleon Sphinx в стиле NumPyDoc
Я использую строки документации в стиле NumPyDoc для документирования пакета Python. Я хотел бы перейти от расширения Sphinx 'numpydoc' к Napoleon, потому что я считаю, что оно форматирует строку документации более компактным и читаемым способом. Те…
20 янв '17 в 11:25
1
ответ
Sphinx autosummary "toctree содержит ссылку на несуществующий документ" предупреждения
Я сталкиваюсь с той же проблемой, что и в этой теме. Когда я собираю свою документацию по Sphinx с make html тогда я получаю много предупреждений, как это None:None: WARNING: toctree contains reference to nonexisting document u'cars.Car.time_elapsed…
02 сен '16 в 06:38
1
ответ
Есть ли способ собрать файл Python для проверки соблюдения стиля документации Numpy?
Я работаю над проектом, который требует документацию Numpy. В свои дни на Java я помню, как в Eclipse/IDEA проверялось линертов, которые проверяли приверженность Javadoc; Есть ли эквивалент, который проверяет соблюдение стиля документации Numpy? Я з…
08 фев '17 в 21:19
1
ответ
Документы Sphinx для составных типов данных
Существует ли в Sphinx стандарт или наилучшая практика для предоставления более точных спецификаций для составных типов данных Python? Например, у меня есть функция, которая возвращает dict отображение str в str и использую numpydoc стиль. Должен ли…
10 апр '15 в 20:26
0
ответов
Сфинкс не удаляет флаги doctest в выводе html
Я не могу устранить флаги doctest (т.е. <BLANKLINE>, # doctest: +ELLIPSIS) для вывода html. Я могу генерировать документацию так, как мне хотелось бы, поэтому ошибок там нет, но она включает в себя эти флаги, которые я бы хотел удалить. Докуме…
07 мар '19 в 21:11
0
ответов
Напишите силу 2 в документации sphinx
Я пытаюсь написать степень 2, но получаю что-то странное. def cal_xy(X, Y): """ Parameters ---------- X : np.ndarray, shape=(2\ :sup:`n`, 2\ :sup:`n`) Y : np.ndarray, shape=(2\ :sup:`n`, n) Returns ------- xy : np.ndarray, shape=(n, 2\ :sup:`n`) """…
08 апр '19 в 15:45
0
ответов
Как документировать несколько возвращаемых значений в формате Numpydoc?
Я пытаюсь задокументировать возвращаемое значение кортежа, используя пустой формат строки документа, но не могу заставить его работать с подсказками типа pycharm. Я пробовал несколько способов, и даже нашел один, который работал для типа, но не позв…
09 май '19 в 17:46
1
ответ
Разбитый формат при использовании numpydoc и sphinx
Я использую сфинкса с расширением numpydoc. когда я создаю html, каждый последний пункт в моем параграфе "Примеры" не работает. Вот что я пытаюсь сделать документ: """ ... Examples -------- Example of using gauss_elem with no option: >>> a …
02 июн '19 в 10:52