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

ПРОГРАМА:

ІМ'Я

epydocgui - графічний інтерфейс до epydoc

СИНТАКСИС

епідогії [project.prj | Модулі...]

епідок -h

епідок -V

ОПИС

епідогії — це графічний інтерфейс до epydoc, який створює документацію API для Python
модулі та пакети на основі їхніх рядків документації. Легка мова розмітки називається
епітекст можна використовувати для форматування рядків документів і для додавання інформації про конкретні поля,
такі як параметри та змінні екземпляра.

Документація API, розроблена епідогії складається з набору файлів HTML. два
підкаталоги створюються для загальнодоступної та приватної документації. Усередині кожного
підкаталогів, кожен клас і модуль документується у власному файлі. Індексний файл, а
дерев, а також файл довідки. Якщо ви виберете кадри варіант, потім а
також створюється зміст на основі фреймів.

ВАРІАНТИ

project.prj
Ім’я файлу проекту, який було збережено епідогії. Запис файлів проекту a
список пов’язаних модулів і параметри, які слід використовувати для створення
документацію для цих модулів.

Модулі...
Список модулів, які необхідно задокументувати. Модулі можна вказати за допомогою
назви модулів (наприклад os.path), імена файлів (наприклад epydoc/epytext.py), або каталог
імена (напр epydoc/). Назви каталогів визначають пакети та розгортаються до
включати всі підмодулі та підпакети.

-h, --допомога, --використання, -?
Відобразити повідомлення про використання.

-V, -- версія
Роздрукуйте версію Epydoc.

HTML ФАЙЛИ

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

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

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

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

trees.html
Ієрархії модулів і класів.

індекси.html
Термін та ідентифікатор індекси.

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

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

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

toc-m-Модулі. Сайтів
Зміст модуля. Ця сторінка відображається в нижньому лівому куті
фрейм і надає посилання на кожен клас, тип, виняток, функцію та
змінна, визначена модулем. Модулі - це повна назва, поставлена ​​крапкою
модуль, наприклад системний or epydoc.epytext. toc-m-Модулі. Сайтів не створюється, якщо
--без рамок використовується варіант.

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

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

Помилки імпорту вказують на те, що epydoc не зміг імпортувати модуль. Зазвичай помилки імпорту
заборонити epydoc створювати документацію для відповідного модуля. Epydoc може
створити такі помилки імпорту:

Басейн Модулі ім'я Модулі
Epydoc спробував імпортувати Модулі, Але Модулі не є дійсним ім'ям для Python
модуль

Could НЕ знаходити a UID та цінності посилання-ціль
Epydoc не зміг знайти об’єкт, на який посилається конструкція вбудованого посилання
(L{...}). Зазвичай це викликано опечаткою в посиланні.

Could НЕ імпорт Модулі
Epydoc спробував імпортувати Модулі, але це не вдалося. Зазвичай це відбувається, коли
Модулі викликає виняток.

файл робить НЕ існувати
Epydoc спробував імпортувати модуль, що міститься в файл, Але файл НЕ
існувати

Помилки Epytext викликані рядками документів Epytext, які містять недійсну розмітку. Кожного разу, коли an
Якщо виявлено помилку epytext, то відповідний рядок документів розглядається як рядок документа відкритого тексту.
Epydoc може генерувати такі помилки Epytext:

Басейн за посиланням мета.
Ціль, визначена для вбудованої конструкції посилання (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, які містять сумнівні або підозрілі
розмітка. Попередження Epytext роблять НЕ запобігти розбору відповідного рядка документів.
Epydoc може генерувати такі попередження про епітекст:

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

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

Попередження про поля викликаються текстовими рядками, що містять недійсні поля. Зміст
недійсного поля, як правило, ігноруються. Epydoc може створити таке поле
попередження:

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

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

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

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

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

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

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

Помилки перевірки генеруються, якщо epydoc стикається з проблемами під час спроби перевірки
властивості документованого об'єкта. Більшість помилок при перевірці не заважають epydoc
від документування об’єкта, про який йде мова. Epydoc може генерувати наступну перевірку
помилки:

Команда параметри of інхметод do НЕ матч базовий метод.
Параметри недокументованого методу інхметод не збігаються з параметрами
методу базового класу базовий метод що воно перевизначає. Як результат, інхметод
не успадковує документацію від базовий метод. Якщо різниця в
параметри є навмисними, то ви можете усунути попередження, додавши a
(можливо, порожній) docstring to інхметод.

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

UID конфлікт виявлено: UID
Двом різним об’єктам epydoc присвоїв однаковий унікальний ідентифікатор. Це
може змусити epydoc замінити документацію одного об’єкта на
документація іншого об'єкта, якому присвоєно такий же унікальний ідентифікатор.
Однак це зазвичай викликає проблеми лише в тому випадку, якщо два об’єкти з однаковими
Унікальними ідентифікаторами є обидва модулі або класи, у цьому випадку API
сторінка документації для одного об’єкта замінить сторінку документації API для
інший об'єкт.

об'єкт з'являється in множинний вбудований Модулі
Під час спроби визначити, який модуль визначає вбудований об’єкт об'єкт,
epydoc зіткнувся з кількома кандидатами, і не зміг вирішити, який
кандидат був правильний. У цьому випадку epydoc довільно вибирає перший
кандидата, якого він знайде.

об'єкт з'являється in множинний .py Модулі
Під час спроби визначити, який модуль визначає вбудований об’єкт об'єкт,
epydoc зіткнувся з кількома кандидатами, і не зміг вирішити, який
кандидат був правильний. У цьому випадку epydoc довільно вибирає перший
кандидата, якого він знайде.

об'єкт з'являється in множинний .тому Модулі
Під час спроби визначити, який модуль визначає вбудований об’єкт об'єкт,
epydoc зіткнувся з кількома кандидатами, і не зміг вирішити, який
кандидат був правильний. У цьому випадку epydoc довільно вибирає перший
кандидата, якого він знайде.

Could НЕ знаходити a Модулі та цінності об'єкт
Epydoc не зміг визначити, який модуль визначає об'єкт. Якщо об'єкт це
функція, то це не дозволить epydoc створювати будь-яку документацію для
об'єкт, оскільки він не знає, на якій сторінці розмістити документацію.
Інакше це завадить документації для об'єкт від включення посилання
до його модуля.

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