Вопросы по теме 'autodoc'
Создание Sphinx Autodoc на основе проекта Google App Engine
У меня есть проект Google App Engine, который я пытаюсь задокументировать с помощью Sphinx. Я пытаюсь использовать функцию autodoc для многих моих модулей / классов / функций.
Разметка My Sphinx reST:
.. automodule:: urls
:members: Urls...
680 просмотров
schedule
05.07.2022
в slime-autodoc: ошибка в фильтре процессов: аргумент неправильного типа: sequencep, :not-available
Когда я использую slime-repl, я получаю это сообщение в своем минибуфере, и emacs зависает на секунду:
ошибка в фильтре процессов: аргумент неправильного типа: sequencep, :not-available
Это перестает происходить, когда я выключаю режим...
695 просмотров
schedule
29.04.2022
Автодокумент Sphinx с Django 1.4
У меня проблемы со сборкой автодокументов модуля для проекта Django 1.4.1. make html , похоже, не может прочитать мои строки документации, потому что у него возникают проблемы с импортом моих настроек. Все онлайн-руководства, которые я видел,...
895 просмотров
schedule
16.04.2023
lein-autodoc с Leiningen 2
Я пытаюсь использовать lein-autodoc , поскольку считаю его предпочтительным генератором документации для Clojure. . Я добавил :dev-dependencies [[lein-autodoc "0.9.0"]] в определение моего проекта в соответствии с инструкциями на странице...
948 просмотров
schedule
15.04.2022
Sphinx: как исключить импорт в автомодуле?
У меня есть проект Raspberry Pi, написанный на Python, который использует модуль RPi.GPIO. Вся работа над кодом выполняется в Windows, где RPi.GPIO не устанавливается, и каждый раз, когда я пытаюсь запустить autodoc, он вылетает, говоря, что не может...
15336 просмотров
schedule
05.07.2023
Sphinx autodoc show-inheritance: Как пропустить недокументированные, промежуточные базы?
У меня есть трехуровневая структура класса:
class Super(object):
"""This class is documented."""
class Intermediate(Super):
pass
class Sub(Intermediate):
"""This is also documented."""
Мой файл index.rst выглядит следующим...
6368 просмотров
schedule
11.09.2023
Будет ли Sphinx работать с кодом, который плохо импортируется?
Будет ли механизм документации Sphinx успешно генерировать документацию по проекту, который плохо импортируется? В частности, мой проект имеет экзотическую зависимость. Я не хочу, чтобы генерация документов зависела от этой зависимости.
Нужно ли...
250 просмотров
schedule
19.09.2022
Проблемы с autodoc и явно указанными атрибутами экземпляра
Я написал класс Python и сделал документацию с помощью sphinx. Например, класс выглядит так:
class Aclass(object):
""" my class """
def __init__(self):
""" constructor """
self.a = None
""" doc for attribute a...
3793 просмотров
schedule
25.10.2022
Функции Sphinx autodoc внутри модуля
Я только начинаю работать со сфинксом и хочу учиться.
Я хотел бы разбить мои различные функции на разные разделы в моем файле index.rst . Таким образом, каждая функция имеет свой собственный заголовок.
Так, например, если у меня есть файл...
7163 просмотров
schedule
11.03.2024
sphinx autodoc включает подфункции
Я хочу автоматически включать подфункции функции в документацию sphinx. Какой вариант для этого?
Мой код выглядит так
import numpy
def mainfunc():
""" to be documented
"""
def subfunc():
""" to be documented as well...
192 просмотров
schedule
13.07.2022
Autodoc работает локально, но не в ReadTheDocs
Я задокументировал некоторые функции с помощью autodoc. Локально работает хорошо. Когда я делаю коммит на GitHub, документация построена на ReadTheDocs, но там нет функций, которые я задокументировал с помощью «automodule».
Я добавил в свой...
1357 просмотров
schedule
27.05.2022
Как указать тип переменных в строках документации Python для Sphinx?
Вы можете указать типы параметров в строках документации Python следующим образом:
def __init__(self, canvas, segments):
"""Class constructor.
:param canvas: the PDF canvas object
:param segment: The layer segments to be drawn....
1584 просмотров
schedule
04.01.2023
интеграция робота с фреймворком sphinx
Я пытаюсь найти способ сделать в основном то, что делает sphinx autodoc , но с каркасом робота. тесты и определяемые пользователем ключевые слова. Я просмотрел sphinxcontrib-robotdoc и sphinxcontrib-robotframework, и ни один из них не делает то,...
280 просмотров
schedule
24.01.2023
Как я могу ссылаться на классы и методы в других файлах моего проекта со Sphinx?
Я пытаюсь написать строки документации Sphinx, которые ссылаются на некоторые классы и методы в других частях моего пакета, но не могу понять, как построить эти ссылки или заставить их отображаться так, как мне нужно.
у меня есть
# a.py
from...
2076 просмотров
schedule
28.05.2022
Автоматически создавать toctree для классов autodoc в Sphinx
Я хочу расширить документацию в одной из моих библиотек. Я использовал sphinx для создания документации и недавно начал изучать расширение autodoc.
Кажется, что в большинстве профессиональных документов на каждой странице документации по классам...
5486 просмотров
schedule
16.02.2023
отключить автоматическое автосуммирование, созданное numpydoc
Можно ли отключить полное автосуммирование при использовании autodoc ?
У меня есть класс, производный от класса стандартной библиотеки Python . , который имеет много общедоступных методов. Мой пользовательский класс должен работать как...
580 просмотров
schedule
19.10.2022
Sphinx застревает при чтении индекса источников
Когда я ввожу make html , Sphinx застревает на сегменте чтения.
При изменении имени в «asp» изменяется процент, на котором он застревает. У меня он был в диапазоне от 100% до 25%. Вот пример того, что я вижу в терминале, когда запускаю make...
1050 просмотров
schedule
16.08.2022
Autosummary с toctree не создает документацию для методов
Я использую sphinx с расширением numpydoc и автосуммированием. После некоторых экспериментов я добавил следующие параметры в свой файл conf.py.
autosummary_generate = True
numpydoc_show_class_members = False
Это дает мне новый файл для...
2792 просмотров
schedule
26.07.2023
Почему toctree не обновляется с помощью темы RTD?
У меня есть программно сгенерированный источник sphinx-doc, который использует тему Read-The-Docs. Исходное дерево выглядит так:
source
├── conf.py
├── index.rst
├── models
│ ├── 1lin
│ │ ├── 1lin_Amplero.rst
│ │ ├── 1lin_Blodgett.rst
│...
635 просмотров
schedule
03.05.2023
Sphinx autodoc и многострочные строки
У меня есть модуль python, который определяет многострочную строковую константу. Я хочу, чтобы многострочная строка хорошо отображалась в документации на основе Sphinx.
Ниже приведен пример кода Python, RST и того, как он отображается с помощью...
2123 просмотров
schedule
02.08.2022
