Описание тега sphinx-apidoc
NoneSphinx-apidoc - это инструмент командной строки для автоматической генерации источников Sphinx reStructuredText, который с расширением Sphinx autodoc документирует весь пакет в стиле других инструментов автоматической документации API.
0
ответов
Используя sphinx-apidoc, make html не может найти модуль
Я использую sphinx-apidoc и, хотя файлы.rst генерируются, кажется, что модули не могут быть проанализированы, когда я запускаю 'make html'. Ошибки выглядят так: WARNING: autodoc: failed to import module u'mathext' from module u'MyRootFolder'; the fo…
20 дек '18 в 14:27
0
ответов
Пропустить / заменить значение атрибута класса на sphinx-apidoc
Я использую sphinx-apidoc для создания документации для программы, которую я пишу. Что происходит то sphinx-apidoc отображает значения атрибутов класса во встроенной документации Например, если я бегу sphinx-apidoc по этому коду: from os.path import…
08 янв '19 в 19:59
0
ответов
Включить документацию моего модуля и его зависимостей в Sphinx
Я пытаюсь документировать написанные мной модули, а также интегрировать документацию из зависимостей. Когда я запустил make build после исполнения sphinx-quickstart и apidoc song and dance, у меня была только документация для вещей, которые я хочу. …
10 дек '17 в 14:54
1
ответ
Как автоматически добавлять типы параметров в документацию sphinx
В настоящее время я пытаюсь реализовать автоматическое создание документации с помощью Sphinx (используя расширения sphinx-apidoc и napoleon). Это работает довольно хорошо, но было бы еще лучше, если бы шрифты (соглашение PEP484) автоматически добав…
28 мар '18 в 17:23
2
ответа
Sphinx: принудительная перестройка html, включая autodoc
В настоящее время, когда я бегу sphinx-build, только когда есть изменения в исходных файлах, встроенные строки документации подобраны и использованы. Я пробовал звонить sphinx-build с -a переключатель, но это, кажется, не имеет никакого эффекта. Как…
09 янв '14 в 11:53
0
ответов
Sphinx создает ссылки в списке переменных на классы с одинаковыми именами
Я использую расширение apidoc от Sphinx для создания документации для проекта Python. Это немного причудливее, чем я ожидал, но у меня большинство вещей работают. Однако, одна странность меня поставила в тупик. У меня есть пара классов с последовате…
28 сен '18 в 17:34
1
ответ
Странный вывод Sphinx-apidoc для приложения django /models.py
Например, я получил пропущенную информацию в сгенерированной документации проекта django. first_name а также last_name, email пропущены (хотя они определены в родительском абстрактном классе). Как контролировать, что добавляется в документацию на ос…
23 сен '17 в 04:17
3
ответа
Автоматическое создание документации для всего содержимого пакета Python
Я пытаюсь автоматически сгенерировать основную документацию для моей кодовой базы, используя Sphinx. Однако у меня возникают трудности с инструкцией Sphinx о рекурсивном сканировании моих файлов. У меня есть кодовая база Python со структурой папок, …
06 янв '11 в 15:44
0
ответов
Sphinx-js не генерирует документацию из файлов.js
Я пытаюсь автоматически сгенерировать документацию проекта, используя Sphinx. Мой проект выглядит так: project | |_docs |_build |_source |_venv ... |_project |_backend |_frontend |_node_modules ... |_src Я создал автоматическую документацию для бэкэ…
12 июл '18 в 08:28
1
ответ
Сфинкс api-doc не собирает пакеты
Фон Мой код имеет следующую структуру: . └── my_package ├── __init__.py ├── classif │ ├── __init__.py │ ├── inference.py │ └── models.py ├── datasets │ ├── __init__.py │ └── datasets.py └── matching ├── __init__.py ├── elastic.py └── search.py После…
17 июл '18 в 08:38
0
ответов
sphinx-apidoc не включает подпакет в сгенерированные файлы
Мой каталог выглядит следующим образом (с надлежащим __init__.py файлы, не перечисленные здесь): root package1/ subpackage1/ submodule1.py module1.py package2/ module2.py docs/ Бег sphinx-apidoc . --full -o docs -H 'MyProject' -A 'MyName' -V '1.0' Я…
19 фев '18 в 11:08
0
ответов
Sphinx некоторые файлы Python не отображаются в индексе HTML
Я пытался использовать sphinx для написания документации для ряда файлов python. Это работает для некоторых из них, но не для всех. После использования sphinx-apidoc первые файлы создаются для всех файлов python, когда я использую make html, создают…
03 июл '18 в 10:27
0
ответов
Включить __main__.py в файлы, созданные sphinx-apidoc
Я не могу правильно добавить свой файл __main__.py и его функции при создании файла RST с помощью sphinx-apidoc. Другие файлы и класс генерируются правильно. Я работаю, только если я запускаю sphinx-apidoc с -P параметр, который включает в себя част…
11 янв '19 в 14:05
0
ответов
Автодок Сфинкса, включая классы и методы
У меня есть классы Python, и некоторые из них находятся в своих собственных файлах т.е. userdata.py: class userdata: """User input class for reading...""" def __init__(self, fname): self.fname = fname def trykey(self,name,injson): .... Я пробовал не…
18 ноя '18 в 08:22
0
ответов
Sphinx apidocs не включает сгенерированные пакетные документы в toctree
У меня есть приложение, которое имеет структуру, похожую на эту. Enigma +docs -enigma -commands __init__.py start.py -core __init__.py +database [...] # Some more python files +plugins Вы можете просмотреть все дерево исходников на Github. проблема …
27 мар '18 в 23:08
2
ответа
Как я могу предотвратить отображение сфинксом полного пути к моему классу?
У меня есть такая структура проекта: package/ __init__.py module.py __init__.py содержит: from .module import Class module.py содержит: class Class: pass С помощью sphinx-apidoc -o package/docs/ package/ а также sphinx-build package/docs/ package/do…
17 сен '17 в 10:53
1
ответ
Перезаписать файлы.rst во время документации Sphinx
Допустим, у нас есть структура документа, которая выглядит следующим образом . |____src | |____abc.py |____docs Теперь мы генерируем документацию с помощью команды: sphinx-apidoc -F -o docs src Это создает несколько файлов в ./docs/ папка, в том чис…
17 май '17 в 05:56
1
ответ
Django-Sphinx RuntimeError: Модели классов моделей. Проект не объявляется
Я пытаюсь сгенерировать HTML-документацию с помощью Sphinx проекта django. Я получаю следующую ошибку при выполнении make html на windows cmd. мой settings.py содержит запись для приложения, которое я построил, где models.py файл принадлежит. По при…
06 дек '17 в 14:22
1
ответ
Настройка Sphinx Autodoc с существующим проектом
Я совершенно новичок в Sphinx и смотрел несколько часов уроков, но не смог найти ответ на свой вопрос У меня есть текущая структура проекта, как показано ниже -project folder |-sub folder 1 | |- sub folder 1.a | | - ... |-sub folder 2 | |- sub folde…
18 апр '19 в 15:26
0
ответов
NoneSphinx -apidoc создает документацию для класса, реэкспортированного в __init__.py
В mypkg/_core.py у меня есть class SomeClass: """Here is my class.""" def __init__(self, x: int): self.x = x В __init__.py у меня есть from mypkg._core import SomeClass Я полагаю, что есть конфигурация по умолчанию, чтобы избежать документирования в…
08 июн '19 в 05:32