epydoc - онлайн у хмарі

ПРОГРАМА:

ІМ'Я

epydoc - генерувати документацію API з рядків документації Python

СИНТАКСИС

епідок [дію] [опції] імена...

ОПИС

епідок створює документацію API для модулів і пакетів Python на основі їх
рядки документів. Легка мова розмітки називається епітекст можна використовувати для форматування
docstrings, а також для додавання інформації про певні поля, наприклад параметри та екземпляр
змінні. Epydoc також розуміє рядки документів, написані на ReStructuredText, Javadoc і
простий текст. Наразі epydoc підтримує два основних формати виводу: HTML і LaTeX.

Документація HTML API, створена епідок складається з набору файлів HTML, включаючи:
сторінку документації API для кожного класу та модуля; сторінку вихідного коду з виділеним синтаксисом
для кожного модуля; сторінка індексу ідентифікатора; сторінку довідки; і таблицю на основі фреймів
зміст. Коли це доречно, епідок також створить сторінки індексу для визначених помилок
умови та справи; сторінка ієрархії класів; і сторінку ієрархії пакетів.

Документація LaTeX API, створена епідок складається з основного файлу LaTeX і LaTeX
файл для кожного модуля. Якщо ви використовуєте --dvi, --psабо --pdf , потім епідок буде викликати зовнішній
команди для перетворення результату LaTeX у потрібний формат. Зверніть увагу, що файли LaTeX
що містить документацію для окремих модулів, можна включити як розділи або
розділи інших документів LaTeX, використовуючи LaTeX \включати команда. Якщо ви бажаєте
включити окремі класи в інші документи LaTeX, а потім використати --окремі класи
можливість створити окремий файл LaTeX для кожного класу.

епідок також можна використовувати для перевірки повноти документації API. За замовчуванням,
він перевіряє, що кожен публічний пакет, модуль, клас, метод і функція мають рядок документації
опис. --тести опцію можна використовувати для визначення додаткових тестів, які потрібно виконати.

ВІДТВОРЕННЯ BUILD ПОВЕДІНКА

Використання поточної дати в документації, створеній Epydoc, призводить до документації, що
є "невідтворюваним", тобто вміст файлів змінюється від збірки до збірки
навіть якщо вихідне дерево цього не робить. Щоб полегшити створення відтворюваних збірок, це
версія Epydoc підтримує дві функції: --no-include-build-time варіант і
SOURCE_DATE_EPOCH змінна оточення

Команда --no-include-build-time опцію можна використовувати, коли ви заздалегідь знаєте, що вам не потрібно
створювати позначки часу у створеній документації. The SOURCE_DATE_EPOCH навколишнє середовище
змінна призначена для використання системами пакування, такими як процес збірки Debian.
Системи пакування встановляться SOURCE_DATE_EPOCH до розумної позначки часу, яка так чи інакше є
пов'язано зі станом вихідного дерева, і ця позначка часу буде використовуватися Eypdoc
ніж поточна позначка часу. Будує за допомогою SOURCE_DATE_EPOCH таким чином буде відтворюватися.

ВАРІАНТИ

Опції Epydoc поділяються на шість категорій: основні параметри, дії, генерація
параметри, параметри виводу, параметри графіка та параметри повернення значення.

BASIC ВАРІАНТИ

Імена...
Перелік об'єктів, які необхідно задокументувати. Об’єкти можна вказати за допомогою
Назви Python із крапками (наприклад os.path), імена файлів (наприклад epydoc/epytext.py),
або назви каталогів (наприклад epydoc/). Назви каталогів визначають пакети та
розширені, щоб включити всі підмодулі та підпакети. Якщо ви бажаєте
виключіть певні підмодулі або підпакети, використовуйте --виключити варіант
(описано нижче).

--config файл
Конфігураційний файл із зазначенням доп опціїта / абоІмена. Цей варіант
може повторюватися.

--q, --спокійно, --v, -багатослівний
Створюйте досить (або докладний) вихід. Якщо використовується кілька разів, цей параметр
виробляє послідовно більш тихий (або докладний) вихід.

--відлагоджувати
Показати повне відстеження внутрішніх помилок.

--простострокові
Не намагайтеся використовувати колір або керування курсором під час відображення індикатора прогресу,
попередження або помилки.

ДІЇ

--html Напишіть вихідний HTML. [за замовчуванням]

--латекс Напишіть вихід LaTeX.

--dvi Запишіть вихід DVI.

--ps Напишіть вихідний постскриптум.

--pdf Напишіть вихідні дані Adobe Acrobat (pdf).

--перевірте Провести перевірку повноти документації.

--соління Запишіть документацію у файл pickle.

ПОКОЛІННЯ ВАРІАНТИ

--документ формат
Встановіть значення за замовчуванням для __docformat__ до формат. __docformat__ є модулем
змінна, яка визначає мову розмітки для рядків документів у модулі.
Його значення складається з назви мови розмітки, за якою необов’язково слідує a
код мови (наприклад en для англійської). Список мов розмітки
наразі розпізнається epydoc, запустити епідок --допомога docformat.

--тільки для розбору
Зберіть всю інформацію про задокументовані об’єкти шляхом розбору відповідних
вихідний код Python; зокрема робити НЕ використовувати самоаналіз для збирання
відомості про документовані об'єкти. Цей параметр слід використовувати, коли
epydoc запускається на ненадійному коді; або на код, який не можна інтроспектувати
через відсутність залежностей або через те, що його імпорт спричинить небажані
побічні ефекти.

--тільки інтроспективний
Зібрати всю інформацію про задокументовані об’єкти шляхом інтроспекції; в
зокрема, робити НЕ збирати інформацію шляхом розбору джерела Python об’єкта
Код.

--виключити ПАТЕРН
Не документуйте жодного об’єкта, ім’я якого відповідає заданому регулярному виразу
рисунок.

--exclude-introspect ПАТЕРН
Не використовуйте самоаналіз для збору інформації про будь-який об’єкт, чиє ім’я
відповідає заданому регулярному виразу.

--exclude-parse ПАТЕРН
Не використовуйте аналіз вихідного коду Python для збору інформації про будь-який об’єкт
ім'я якого відповідає заданому регулярному виразу.

-- успадкування формат
Формат, який слід використовувати для відображення успадкованих методів, змінних і
властивостей у згенерованих «зведених» таблицях. Якщо формат то «згруповано».
успадковані об’єкти об’єднуються в групи залежно від класу
успадкований від. Якщо формат є "переліком", то успадковані об'єкти перераховуються в а
короткий список в кінці підсумкової таблиці. Якщо формат то «включено».
успадковані об'єкти змішуються з неуспадкованими об'єктами. Формат за замовчуванням
для виведення HTML є "згрупованим".

--show-приватний, --не приватний
Ці параметри визначають, чи створюється документація для приватних об’єктів.
За замовчуванням створена документація включає приватні об’єкти, і користувачі можуть
виберіть, переглядати приватні об’єкти чи ні, натиснувши «показати приватні»
і "приховати приватні" посилання. Але якщо ви хочете перешкодити користувачам безпосередньо
отримати доступ до приватних об’єктів, то ви можете не створювати документацію
для приватних об'єктів.

--show-imports, --без імпорту
Ці параметри визначають, чи буде імпорт модуля включено до згенерованого
документація. За замовчуванням імпорт не включено.

--show-sourcecode, --без вихідного коду
Ці параметри визначають, чи повинен epydoc генерувати виділений синтаксис
сторінки, що містять вихідний код кожного модуля у виводі HTML. За замовчуванням,
створюються сторінки вихідного коду.

--include-log
Створіть сторінку HTML epydoc-log.html містить усі повідомлення про помилки та попередження
які генеруються за допомогою epydoc, і включати їх у згенерований вихід.

--no-include-build-time
Не друкуйте час складання в нижньому колонтитулі сторінки. Це корисно, якщо ви є
намагаючись створити відтворювані збірки, де кожна збірка порівнюється з заданим
версія вихідного дерева створює точно такі ж артефакти.

ВИХІД ВАРІАНТИ

-o реж, - вихід реж
Вихідний каталог. Якщо реж не існує, то він буде створений. Якщо ні
вказано вихідний каталог, потім ім'я дії (наприклад, HTML or PDF). HTML

-c лист, --css лист
Таблиця стилів CSS для вихідних файлів HTML. Якщо лист це файл, потім таблиця стилів
копіюється з цього файлу; інакше, лист вважається ім'ям а
вбудована таблиця стилів. Щоб отримати список вбудованих таблиць стилів, запустіть епідок --допомога
CSS. Якщо таблиця стилів CSS не вказана, то буде таблиця стилів за замовчуванням
використаний

-n ім'я, --ім'я ім'я
Назва проекту, документація якого формується.

-u URL, --url URL
URL-адреса домашньої сторінки проекту.

--navlink HTML
HTML-код для посилання на домашню сторінку на панелі навігації HTML. Якщо цей HTML-код
містить будь-які гіперпосилання (<a href=...>), потім його буде вставлено дослівно. Якщо
він не містить жодних гіперпосилань, а вказано URL-адресу проекту (з
--url), потім до посилання додається гіперпосилання на вказану URL-адресу.

--довідковий файл файл
Альтернативний файл довідки. файл має містити тіло HTML-файлу --
до нього будуть додані панелі навігації.

--шоу-кадри, --без рамок
Ці параметри контролюють, чи буде вихід HMTL включати таблицю на основі кадрів
сторінку вмісту. За замовчуванням включається зміст на основі фреймів.

--окремі класи
У висновку LaTeX опишіть кожен клас в окремому розділі
документації, замість того, щоб включати їх у документацію для їх
модулі. Це створює окремий файл LaTeX для кожного класу, тому він також може бути
корисно, якщо ви хочете включити документацію для одного або двох класів як
розділи вашого власного документа LaTeX.

ГРАФ ВАРІАНТИ

--граф тип графіка
Включіть графіки типу тип графіка у створеному виході. Формуються графіки
за допомогою виконуваного файлу Graphviz dot. Якщо цього виконуваного файлу немає на шляху, то
використання --шлях точок щоб вказати його місцезнаходження. Цей параметр можна повторити, щоб включити
кілька типів графіків у виводі. тип графіка має бути одним із: всі,
класове дерево, Callgraphабо umlcllasstree.

--шлях точок шлях
Шлях до Графвізу точка виконуваний файл

--графічний шрифт шрифт
Назва шрифту, який використовується для створення графіків Graphviz. (наприклад, helvetica або
разів).

--розмір шрифту графіка розмір
Розмір шрифту, який використовується для створення графіків Graphviz, у пунктах.

--pstat файл
Вихідний файл pstat, який використовується для створення графіків викликів.

ПОВЕРНЕННЯ VALUE ВАРІАНТИ

--збій під час помилки
Повернути ненульовий статус виходу, що вказує на помилку, якщо є помилки
стикалися.

--попередження про несправність
Повертає ненульовий статус виходу, що вказує на помилку, якщо є помилки чи попередження
зустрічаються (не враховуючи попереджень рядка документів).

--fail-on-docstring-попередження
Повертає ненульовий статус виходу, що вказує на помилку, якщо є помилки чи попередження
зустрічаються (включаючи попередження про рядки документів).

HTML ФАЙЛИ

Документація HTML API, створена епідок складається з таких файлів:

ОБ'ЄКТ ДОКУМЕНТАЦІЯ СТОРІНКИ

index.html
Стандартна точка входу для документації. зазвичай, index.html є копією
файлу фреймів (frames.html). Але якщо --без рамок тоді використовується опція
index.html є копією домашньої сторінки документації API, яка зазвичай є
сторінка документації для пакета або модуля верхнього рівня (або сторінка дерев якщо
немає пакета або модуля верхнього рівня).

Модулі-module.html
Документація API для модуля. Модулі - це повна назва, поставлена ​​крапкою
модуль, наприклад системний or epydoc.epytext.

клас-class.html
Документація API для класу, винятку або типу. клас є повним
пунктирна назва класу, наприклад epydoc.epytext.Token or масив.Тип масиву.

Модулі-pysrc.html
Сторінка з виділеною синтаксисом, що містить вихідний код Python для Модулі, це
сторінка містить посилання на сторінки документації API.

module-tree.html
Ієрархія модулів.

class-tree.html
Ієрархія класів. Ця сторінка створюється, лише якщо є хоча б один клас
документально.

ПОКАЗНИКИ

ідентифікатор-індекс.html
Індекс усіх задокументованих ідентифікаторів. Якщо індекс ідентифікатора містить більше
ніж 3,000 записів, то він буде розділений на окремі сторінки для кожної літери,
названий ідентифікатор-індекс-a.html, ідентифікатор-індекс-b.html, І т.д.

term-index.html
Покажчик усіх явно позначених термінів визначення. Ця сторінка лише
генерується, якщо принаймні один термін визначення позначений у форматованому рядку документів.

bug-index.html
Індекс усіх явно позначених @bug поля. Ця сторінка створюється лише якщо
принаймні один @bug поле вказано у форматованому рядку документів.

todo-index.html
Індекс усіх явно позначених @робити поля. Ця сторінка створюється лише якщо
принаймні один @робити поле вказано у форматованому рядку документів.

change-index.html
Індекс усіх явно позначених @змінено поля. Ця сторінка лише генерується
якщо хоча б один @змінено поле вказано у форматованому рядку документів.

deprecated-index.html
Індекс усіх явно позначених @застаріло поля. Ця сторінка лише
створюється, якщо хоча б один @застаріло поле вказано у форматованому рядку документів.

оскільки-index.html
Індекс усіх явно позначених @з тих пір поля. Ця сторінка лише генерується
якщо хоча б один @з тих пір поле вказано у форматованому рядку документів.

НА ОСНОВІ РАМКИ ТАБЛИЦЯ OF ЗМІСТ

frames.html
Основний файл кадрів. Дві рамки з лівого боку вікна містять a
зміст, а основна рамка в правій частині вікна містить
Сторінки документації API.

toc.html
Сторінка змісту верхнього рівня. Ця сторінка відображається у верхньому лівому куті
рамка з frames.html, і надає посилання на toc-все.html та
ток-Модулі-module.html сторінок.

toc-все.html
Зміст всього проекту. Ця сторінка відображається в
нижній лівий кадр frames.htmlі надає посилання на кожен клас, тип,
виняток, функція та змінна, визначені проектом.

ток-Модулі-module.html
Зміст модуля. Ця сторінка відображається в нижньому лівому куті
рамка з frames.htmlі надає посилання на кожен клас, тип, виняток,
функція та змінна, визначена модулем. Модулі є повний пунктир
назва модуля, наприклад системний or epydoc.epytext.

ІНШІ СТОРІНКИ

help.html
Сторінка допомоги проекту. На цій сторінці пояснюється, як використовувати та переміщатися
веб-сторінка, створена epydoc.

redirect.html
Ця сторінка використовує javascript для перекладу назв із крапками на відповідні
URL-адреси. Наприклад, у документації epydoc завантаження сторінки
автоматично перенаправить
браузер до .

epydoc.css
Таблиця стилів CSS, що використовується для відображення всіх сторінок HTML.

epydoc.js
Файл javascript, який використовується для визначення функцій JavaScript, які використовуються в epydoc.

epydoc-log.html
Сторінка, що містить журнал усіх попереджень і помилок, які були згенеровані
epydoc разом із таблицею з переліком усіх використаних параметрів.

ЛАТЕКС ФАЙЛИ

Документація LaTeX API, створена епідок складається з таких файлів:

api.pdf
Файл Adobe Acrobat (pdf), що містить повну документацію API. Це
файл створюється, лише якщо ви використовуєте файл --pdf варіант.

api.tex
Файл LaTeX верхнього рівня. Цей файл імпортує інші файли LaTeX, щоб створити файл
єдиний уніфікований документ.

api.dvi
Файл dvi, що містить повну документацію API. Цей файл лише
створюється, якщо ви використовуєте --dvi варіант, --ps варіант, або --pdf варіант.

api.ps Файл postscript, що містить повну документацію API. Цей файл лише
створюється, якщо ви використовуєте --ps опція або --pdf варіант.

Модулі-module.tex
Документація API для модуля. Модулі - це повна назва, поставлена ​​крапкою
модуль, наприклад системний or epydoc.epytext.

клас-class.tex
Документація API для класу, винятку або типу. клас є повним
пунктирна назва класу, наприклад epydoc.epytext.Token або array.ArrayType.
Ці файли документації класу створюються лише за умови --окремі класи
використовується опція; в іншому випадку документація для кожного класу включена в його
файл документації модуля.

ДІАГНОСТИКА

EPYTEXT МАРКУП УВАГА ПОВІДОМЛЕННЯ
Помилки Epytext викликані рядками документів Epytext, які містять недійсну розмітку. Завжди
виявлено помилку epytext, відповідний рядок документів розглядається як відкритий текст
docstring. Epydoc може генерувати такі помилки epytext:

поганий link мета.
Ціль, визначена для вбудованої конструкції посилання (L{...}) не добре -
сформований. Цілі посилань мають бути дійсними ідентифікаторами Python.

поганий з мета.
Ціль, визначена для вбудованої конструкції uri (У{...}) не добре сформований.
Зазвичай це відбувається, якщо вбудована розмітка вкладена всередині цілі URI.

Поля повинен be at топ рівні.
Список полів (@param, тощо) міститься в якійсь іншій блочній структурі
(наприклад, список або розділ).

Поля повинен be остаточний елементи.
Список полів (@param, тощо) не знаходиться в кінці рядка документів.

Рубрики повинен відбуваються at топ рівні.
Заголовок міститься в іншій структурі блоку (наприклад, у списку).

Неправильний doctest блок відступ.
Блок doctest відступає за відступ початкового рядка підказки.

Неправильний заголовок відступ.
Заголовок розділу не вирівнюється по лівому краю з абзацами
розділ, що містить його.

Неправильний пункт відступ.
Абзаци в блоку не вирівнюються за лівим краєм. Ця помилка зустрічається часто
генерується, коли рядки документації відкритого тексту аналізуються за допомогою epytext.

Недійсний Втеча.
Невідома escape-послідовність була використана з вбудованою escape-конструкцією
(Е{...}).

списки повинен be з відступом.
Рядок без відступу безпосередньо після абзацу починається з маркера списку.
Epydoc не впевнений, чи ви хотіли створити новий елемент списку, чи призначено для a
абзац, щоб включити слово, схоже на кулю. Якщо ви мали намір
попередній, потім відступ у списку. Якщо ви планували останнє, змініть
перенесення слів абзацу або екранування першого символу слова
виглядає як куля.

Неврівноважений '{'.
Рядок документації містить незбалансовані дужки. Epytext вимагає, щоб усі дужки були
має бути збалансованим. Щоб включити одну незбалансовану дужку, використовуйте escape
послідовності E{lb} (ліва дужка) і E{rb} (права дужка).

Неврівноважений '}'.
Рядок документації містить незбалансовані дужки. Epytext вимагає, щоб усі дужки були
має бути збалансованим. Щоб включити одну незбалансовану дужку, використовуйте escape
послідовності E{lb} (ліва дужка) і E{rb} (права дужка).

Невідомий вбудований розмітка бирка.
З конструкцією вбудованої розмітки був використаний невідомий тег ( x{...} ).

Неправильно підкреслення характер та цінності заголовок.
Символ підкреслення, що використовується для заголовка цього розділу, не вказує на символ
відповідний рівень розділу. Для підкреслення слід використовувати символ "="
секції; «-» для підрозділів; і "~" для підрозділів.

це можливо неправильно відформатований поле пункт.
Epytext виявив рядок, який виглядає як елемент поля, але є неправильним
відформатовано. Зазвичай це відбувається, коли кінцева двокрапка (":") не включена
у тег поля.

це можливо заголовок друкарська помилка.
Epytext виявив пару рядків, схожих на заголовок, але їх кількість
символи підкреслення не відповідають кількості символів у заголовку.
Кількість символів у цих двох рядках має точно збігатися, щоб вони були
розглядається як заголовок.

область ПОПЕРЕДЖЕННЯ
Попередження про поля викликаються рядками документів, які містять недійсні поля. Зміст
недійсні поля зазвичай ігноруються. Epydoc може генерувати наступне поле
попередження:

@param та цінності невідомий параметр парам.
Поле @param було використано для визначення типу параметра, який не є
включено в сигнатуру функції. Зазвичай це викликано друкарською помилкою
ім'я параметра.

тег зробив НЕ очікувати an аргумент.
Тег поля тег був використаний з аргументом, але він не бере один.

тег очікуваний an аргумент.
Тег поля тег був використаний без аргументу, але він вимагає одного.

@type та цінності невідомий параметр парам.
Поле @type було використано для визначення типу параметра, який не включено
в сигнатурі функції. Зазвичай це викликано опечаткою в
ім'я параметра.

@type та цінності невідомий змінна було.
Поле @type використовувалося для визначення типу змінної, але ніякого іншого
відомості про змінну. Зазвичай це викликано друкарською помилкою
ім'я змінної.

Невідомий поле тег тег.
Рядок документів містить поле з невідомим тегом тег.

Перевизначення of поле.
Кілька тегів полів визначають значення поле в тому ж рядку документів, але поле
може приймати лише одне значення.

ПРИКЛАДИ

епідок -n епідок -u http://epydoc.sf.net epydoc/
Згенеруйте документацію HTML API для пакета epydoc та всього його
підмодулі та запишіть вихід у файл HTML каталог. У заголовках і
колонтитули, корист епідок як назва проекту та http://epydoc.sf.net як проект
URL-адреса.

епідок --pdf -n епідок epydoc/
Згенеруйте документацію API LaTeX для пакета epydoc та всього його
підмодулі та запишіть вихід у файл латекс каталог.

EXIT СТАТУС

0 Успішне виконання програми.

1 Помилка використання.

2 Epydoc згенерував помилку або попередження та один із варіантів --збій під час помилки,
--попередження про несправність, or --fail-on-docstring-попередження було зазначено.

інший Внутрішня помилка (виняток Python).

Використовуйте epydoc онлайн за допомогою служб onworks.net