Описание тега epydoc
Epydoc - это инструмент для создания документации API для модулей Python на основе их строк документации.
0
ответов
Предупреждение об эпидемии с помощью @abstractproperry
Я не то, что мне не хватает, но следующий код: from abc import ABCMeta, abstractproperty class Abstra(object): __metaclass__ = ABCMeta def __init__(self): self.var = 77 @abstractproperty def varb(self): ''' returns var ''' выдает следующую ошибку ep…
21 янв '13 в 03:33
1
ответ
epydoc и reStructuredText меняют имя ссылки
Я использую reStructuredText с epydoc. Как я могу иметь текст внутренней ссылки, отличной от цели ссылки? Я имею: :todo: Figure out the `Product.manufacturer` relationship in `Product`. Ссылка на продукт выглядит хорошо и ссылается на объект Product…
18 авг '10 в 18:00
1
ответ
Epydoc скрыть некоторые функции класса?
У меня есть некоторые методы в моем классе, которые предназначены только для использования другими методами класса. Я поставил перед их именами '_'. Могу ли я скрыть эти функции от epydoc? Это хорошая идея? Должен ли я использовать '_' или двойное п…
04 окт '11 в 14:34
1
ответ
Нужна помощь с KeyError при создании файлов epydoc для проекта
У меня есть проект по пилонам с обширным набором функциональных тестов, которые я хочу, чтобы время от времени мои контрольные программы могли читать, поэтому я использую epydoc для создания hdml pydocs на модулях функциональных тестов. Кажется, раб…
29 окт '10 в 19:50
0
ответов
Смысл обозначений Эпидока, L{ClassName} C{int}?
Читая чужой код, я наткнулся на этот тип документации @param reporter: A L{Reporter} instance, where ... и выяснил после некоторого поиска, что это Epydoc. Но что означают такие обозначения, как L{ClassName?} а также C{type?} имею в виду?
13 май '16 в 04:14
1
ответ
Как включить диаграмму Graphviz в документы Python с помощью epydoc?
Документация Epydoc гласит, что вы можете включить диаграмму Graphviz в свой исходный код с помощью dotgraph директивы. Однако, если попробовать это: #: .. dotgraph:: Test #: graph name { #: a -- b -- c; #: b -- d; #: } То, что я получаю, это прост…
08 май '12 в 07:31
0
ответов
Тип хинтинга и генерация эпидока
В качестве примера приведена следующая функция: def add(x: int, y: int) -> int: """ @param x: the first integer @param y: the second integer """ return x + y Как я могу запустить epydoc (или pydoc), чтобы он распознавал подсказки типов и дал мне …
01 ноя '17 в 14:23
3
ответа
Запустите epydoc и / или сборки pylint из файла scons
Как бы я создал строителей, которые запускают epydoc и / или pylint из собранных scons?
03 авг '12 в 08:08
3
ответа
epydoc AttributeError: у объекта "Текст" нет атрибута "данные"
Я не использовал epydoc в последние 2 года, но мне было очень удобно отслеживать свои занятия и методы с очень небольшими усилиями. Сегодня я установил последнюю версию 3.0.1 но я получаю эту ошибку, и поиск вокруг, кажется, не предлагает никаких ре…
15 июл '11 в 09:01
1
ответ
Как запустить epydoc gui для win7?
Документация epydoc гласит:The graphical interface can be invoked with the epydocgui command, or with epydoc.pyw in the Scripts subdirectory of the Python installation directory under Windows. Я пытался запустить epydoc.pyw файл и вызов его из коман…
16 окт '15 в 19:33
0
ответов
У epydoc автоматически запускаются докуты
У меня есть ночная работа по epydoc для генерации документации, но я также хотел бы, чтобы она выполняла мои тесты документации. Кто-нибудь знает способ автоматического запуска docstring тестов для каждого файла, для которого он создает документацию…
03 дек '14 в 17:59
1
ответ
Как получить трассировку стека из epydoc при загрузке моего кода?
Когда я загружаю свой код в epydoc и просто загрузите верхний модуль, с которым не получается: Error: TypeError: 'NoneType' object is not callable (line 10) Где то NoneType он ссылается на подмодуль, который я пытался загрузить в строке 9. Как я мог…
22 янв '10 в 23:29
1
ответ
Эпидок: блоки текста фиксированной ширины
Я написал программный компонент, который опирается на файл конфигурации. Для ясности я хочу задокументировать структуру файла конфигурации, добавив файл примера в строку документации соответствующего класса. По понятным причинам он должен отображать…
18 авг '10 в 15:04
1
ответ
Документирование публичных глобальных функций с помощью epydoc
У меня есть модуль, содержащий несколько глобальных функций и глобальную переменную. Переменная и некоторые функции следуют "частному" соглашению об именах для Python, с основным подчеркиванием для имени. Другие функции должны быть общедоступными и …
12 июл '10 в 20:20
1
ответ
restructuredText, docstring и python интерактивная оболочка
Я использую reStructuredText для документирования своего кода, чтобы получить красивые офлайн-страницы HTML с помощью epydoc. Результаты блестящие. Единственным недостатком является то, что когда я использую интерактивную оболочку Python, функция he…
09 фев '11 в 20:13
1
ответ
Epydoc выполняет файл Python
У меня есть файл Python с несколькими классами в нем и хотел использовать epydoc для создания документации из моих комментариев. Так что я делаю на консоли в моей системе Debian wheezy: epydoc --html storage_config_tool.py -o ~/ Он всегда выполняет …
08 май '14 в 13:03
4
ответа
Автоматизированный способ перехода от форматирования строки документации epydoc к форматированию строки sphinx?
У меня есть проект, который я задокументировал с помощью epydoc. Сейчас я пытаюсь переключиться на сфинкса. Я отформатировал все мои строки документов для эпидока, используя B{}, L{} и т. Д. Для жирного шрифта, ссылок и т. Д., И используя @param, @r…
04 апр '12 в 14:04
1
ответ
Как заставить параметры epydoc показывать в прототипе функции?
Использование epydoc, версия 3.0.1. Я попробовал эту простую вещь: def SetNetwork(self, PyLabNetwork net): """ Set the net !!! @param self: How long they should think. @type self: C{int} or L{PyLabNetwork} @param net: How long they should think. @ty…
31 янв '13 в 01:13
1
ответ
Принудительное использование типов параметров функции Python из строки документации
Генераторы документов epydoc и Sphinx позволяют кодировщику комментировать, какие типы должны быть у любого / всех параметров функции. Мой вопрос: есть ли способ (или модуль), который обеспечивает эти типы (во время выполнения), когда задокументиров…
10 дек '14 в 12:41
2
ответа
Есть ли способ исключить определенный файл из поколения epydoc?
Я создаю epydoc для библиотеки кода, и есть несколько тестовых файлов, разбросанных по всему, которые я бы не хотел включать. Я мог бы использовать --exclude возможность генерации и переименования файлов, но мне интересно, есть ли что-нибудь, что я …
16 дек '10 в 21:52