Описание тега autodoc
Extension for the Sphinx documentation generator that imports Python modules in order to extract docstrings in a semi-automatic way.
0
ответов
Sphinx autodoc не может импортировать / найти модуль
Я новичок в сфинксе. Я получил что-то в самом начале. Моя структура файлов действительно проста: conf.py index.rst p1.rst p1 (документ) m1.py (файл в p1) m2.py (файл в p1) ... в p1.rst пишет: .. automodule:: p1.m1 :members: и я добавляю абстрактный …
07 янв '15 в 11:51
3
ответа
Python Sphinx исключает шаблоны
Я генерирую документацию с помощью Sphinx для проекта со структурой, подобной этой: + project | +- docs | +- tests | +- workflow -+- definitions -+- <some folders> | +- <rest of the project> Я хочу исключить тесты и рабочий процесс / опр…
05 май '17 в 09:41
1
ответ
В Sphinx, как включить строки документации / комментарии, расположенные в модуле, но вне класса и методов
У меня есть utils Модуль в моей упаковке. Он состоит из нескольких разных методов, которые не требуют реализации. Я хотел бы разместить некоторые общие комментарии / документацию внутри этого utils файл, такой как: import os import json """ Miscella…
02 ноя '17 в 09:39
1
ответ
Как задокументировать отдельный приватный атрибут с помощью автодока Sphinx?
Я использую sphinx и расширение autodoc для автоматического создания документации из строк документации в моих модулях python. Я в настоящее время использую automodule директива для документирования всех открытых членов модуля .. automodule:: :membe…
31 янв '19 в 18:00
0
ответов
Не генерируется никаких выходных данных для автоматического документирования с помощью sphinx на коде fortran
Мы хотим использовать инструмент Autodoc Sphinx для составления документации на фортрановые программы. Используя два расширения, разработанных vacumm "vacumm.sphinxext.fortran_domain" и "vacumm.sphinxext.fortran_autodoc", мы должны быть в состоянии …
15 янв '15 в 13:18
0
ответов
Sphinx включает в себя описания библиотек кода, где он не должен
Я работаю над документацией оболочки Python вокруг приложения PyObjC со Sphinx. Sphinx добавляет запутанное и нежелательное описание библиотеки кода библиотеки к описанию свойства этого класса, которое оказывается кодом (см. Скриншот, вторая последн…
08 июн '15 в 19:44
1
ответ
Проверьте, комментируется ли класс Java в хуке SVN Precommit
Я хочу убедиться, что Java-класс закомментирован, прежде чем кто-то что-то сделает в SVN-репозитории. Поэтому я хочу реализовать следующий рабочий процесс: Пользователь меняет что-то в классе Пользователь хочет зафиксировать класс Перед выполнением …
15 фев '14 в 10:27
0
ответов
Sphinx - получить документацию по функциям без подписи
У меня есть скрипт на Python, который я документирую с помощью Sphinx. Одним из входных данных для скрипта является текстовый файл, который я анализирую в отдельной функции, скажем, parse_file(f), Документ для parse_file где этот текстовый формат за…
25 окт '16 в 15:47
0
ответов
Как добавить sphinx документы из импортированных библиотек в Python?
У меня есть скрипт на python "webaton.py", который импортирует селен. У меня есть строки документации для моих методов в моем собственном классе в webaton.py, и я установил некоторые методы селена как метод моего класса, используя setattr( ) метод. …
16 июн '18 в 17:55
0
ответов
Проблемы с Sphinx документированием методов класса
Я пытаюсь использовать Sphinx для документирования создаваемого пакета Python, и все работало нормально, пока я не добавил несколько классов. Я просто предоставлю полный набор предупреждений, чтобы не пропустить что-то важное: Running Sphinx v1.2.3 …
10 мар '15 в 05:42
4
ответа
Автодок Сфинкса не достаточно автоматический
Я пытаюсь использовать Sphinx для документирования проекта на 5000 строк в Python. Имеет около 7 базовых модулей. Насколько я знаю, чтобы использовать autodoc, мне нужно написать такой код для каждого файла в моем проекте: .. automodule:: mods.set.t…
23 апр '10 в 21:11
1
ответ
Ошибка импорта ReadTheDocs из __init__.py
У меня проблемы с readdhedocs autodocs - сборка завершена, но моя документация пуста для каждого класса. Глядя на информацию о сборке, кажется, что получает синтаксическую ошибку, которая вызывает несколько предупреждений: print(clean_sample, file=o…
27 апр '18 в 14:14
1
ответ
Структура каталогов Sphinx для rst и html генерируется
Я работал над настройкой автоматической документации для моих файлов Python, которые находятся в большой иерархии структуры каталогов. Я могу сгенерировать файлы rst и html для всех из них с помощью моих скриптов и с помощью модуля autodoc. Мне было…
15 сен '17 в 06:09
0
ответов
Почему sphinx autodoc выводит строку документации декоратора, когда в методе есть два декоратора?
С помощью sphinx autodoc я хочу создать документацию для метода, который имеет @classproperty а также @classmethod декораторы. Вместо документации метода я получаю @classmethodДокументация. Если я удаляю один из декораторов, все работает правильно. …
21 апр '17 в 14:13
0
ответов
Конфликты конечной точки маршрута при создании документа sphinx для api колбы restful
Я пытаюсь создать документацию для веб-приложения Flask, которое включает встроенный в него REST-подобный API. Я использую sphinx, в частности расширение httpdomain из sphinxcontrib, использую модуль autohttp.flask для автоматической генерации моих …
01 фев '17 в 04:04
0
ответов
Sphinx autodoc дублирует имя модуля и имя функции
У меня есть модуль Python со следующей структурой: my_mod |--- __init__.py |--- mod1 | |---- __init__.py |---- testA.py |---- testB.py |---- testC.py Внутри каждого testX.py есть отдельная функция с именем testX. Эти функции велики, поэтому, чтобы м…
01 фев '19 в 18:59
1
ответ
Можно ли изменить формат кортежа / списка python autodoc?
У меня есть некоторый код Python в проекте, который я хочу документировать, однако я столкнулся с проблемой документирования констант классов, которые являются кортежами или списками. Смотрите код и изображение ниже. Очень трудно читать документацию…
22 фев '19 в 09:20
0
ответов
Как установить настройки по умолчанию для многих автомодулей?
Предположим, у вас есть несколько классов и сгенерируйте документацию, используя Sphinx. Вместо того чтобы писать: ReverseRecallCommandLines ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. autoclass:: ReverseRecallCommandLines :members: :special-mem…
11 янв '19 в 00:49
5
ответов
Сфинкс не может найти мои файлы Python. Говорит "нет модуля с именем..."
У меня есть вопрос, касающийся генерации автодока Сфинкса. Я чувствую, что то, что я пытаюсь сделать, должно быть очень простым, но по какой-то причине это не сработает. У меня есть проект Python, каталог которого называется slotting_tool. Этот ката…
07 дек '18 в 10:52
2
ответа
sphinx-apidoc подбирает подмодули, но autodoc не документирует их
Я работал над проектом для PyQt5 (находится здесь: https://github.com/MaVCArt/StyledPyQt5), который использует структуру пакета, чтобы сделать импорт немного более логичным. До сих пор я был относительно успешным в документировании кода с помощью Sp…
10 авг '16 в 23:28