epydocgui - 클라우드에서 온라인

프로그램:

이름

epydocgui - epydoc에 대한 그래픽 인터페이스

개요

에피독귀 [프로젝트.prj | 모듈...]

에피독 -h

에피독 -V

기술

에피독귀 Python에 대한 API 문서를 생성하는 epydoc에 대한 그래픽 인터페이스입니다.
모듈과 패키지는 docstring을 기반으로 합니다. 가벼운 마크업 언어라고 합니다.
에피텍스트 docstring을 포맷하고 특정 필드에 대한 정보를 추가하는 데 사용할 수 있습니다.
매개변수와 인스턴스 변수 등이 있습니다.

API 문서는 다음에 의해 생성됩니다. 에피독귀 HTML 파일 세트로 구성됩니다. 두 개
공개 및 비공개 문서에 대한 하위 디렉토리가 생성됩니다. 각 디렉토리 내에서
하위 디렉토리, 모든 클래스와 모듈은 자체 파일에 문서화되어 있습니다. 인덱스 파일,
trees 파일과 도움말 파일도 생성됩니다. 프레임 옵션, 그 다음에는
프레임 기반 목차도 생성됩니다.

옵션

프로젝트.prj
저장된 프로젝트 파일의 이름 에피독귀. 프로젝트 파일은 다음을 기록합니다.
관련 모듈 목록 및 생성에 사용해야 하는 옵션
해당 모듈에 대한 문서입니다.

모듈...
문서화해야 할 모듈 목록입니다. 모듈은 다음을 사용하여 지정할 수 있습니다.
모듈 이름(예: OS.경로), 파일 이름(예: 에피독/에피텍스트.py), 또는 디렉토리
이름(예: 에피독/). 디렉토리 이름은 패키지를 지정하고 다음으로 확장됩니다.
모든 하위 모듈과 하위 패키지를 포함합니다.

-시간, --돕다, --용법, -?
사용 메시지를 표시합니다.

-V, --번역
Epydoc 버전을 인쇄하세요.

HTML 파일

API 문서는 다음에 의해 생성됩니다. 에피독 다음 파일로 구성됩니다.

index.html 페이지
문서의 표준 진입점입니다. 보통, index.html 페이지 하는
프레임 인덱스 파일은 세 개의 프레임을 정의합니다. 왼쪽에 두 개의 프레임이 있습니다.
브라우저에는 목차가 포함되어 있으며 오른쪽에 메인 프레임이 있습니다.
창에는 문서 페이지가 포함되어 있습니다. 그러나 --노 프레임 옵션은
사용한 다음 index.html 페이지 사용자를 프로젝트의 최상위 페이지로 리디렉션합니다.

m-모듈.html
모듈에 대한 API 설명서입니다. 모듈 점으로 구분된 전체 이름입니다.
와 같은 모듈 sys or 에피독.에피텍스트.

c-클래스.html
클래스, 예외 또는 유형에 대한 API 설명서입니다. c 완전한
클래스의 점으로 구분된 이름(예: epydoc.epytext.토큰 or 배열.배열 유형.

나무들.html
모듈과 클래스 계층.

인덱스.html
용어 및 식별자 인덱스.

help.html
프로젝트의 도움말 페이지입니다. 이 페이지는 사용 및 탐색 방법을 설명합니다.
epydoc에서 제작한 웹페이지입니다.

toc.html
최상위 목차 페이지입니다. 이 페이지는 왼쪽 상단에 표시됩니다.
프레임을 제공하고 링크를 제공합니다. toc-everything.html 그리고 토크-엠-모듈.html 중에서
파일. toc.html 생성되지 않는 경우 --노 프레임 옵션이 사용됩니다.

toc-everything.html
전체 프로젝트의 목차입니다. 이 페이지는
왼쪽 아래 프레임에는 모든 클래스, 유형, 예외, 함수에 대한 링크가 제공됩니다.
프로젝트에서 정의한 변수입니다. toc-everything.html 생성되지 않습니다
전에, --노 프레임 옵션이 사용됩니다.

토크-엠-모듈.html 중에서
모듈의 목차입니다. 이 페이지는 왼쪽 하단에 표시됩니다.
프레임을 제공하고 모든 클래스, 유형, 예외, 함수에 대한 링크를 제공합니다.
모듈에 의해 정의된 변수. 모듈 점으로 구분된 전체 이름입니다.
와 같은 모듈 sys or 에피독.에피텍스트. 토크-엠-모듈.html 중에서 생성되지 않습니다
전에, --노 프레임 옵션이 사용됩니다.

에피독.css
모든 HTML 페이지를 표시하는 데 사용되는 CSS 스타일시트입니다.

기본적으로, 에피독 출력 디렉토리에 두 개의 하위 디렉토리를 생성합니다. 공개 그리고 사설.
각 디렉토리에는 위에 지정된 모든 파일이 포함되어 있습니다. 그러나 --비공개 option
를 사용하면 하위 디렉토리가 생성되지 않고 공개 문서가 작성됩니다.
출력 디렉토리로 직접 전송됩니다. 5가지 범주로 구분됩니다. 가져오기 오류, epytext
오류; epytext 경고; 필드 경고; 및 검사 오류. Whenver epydoc
오류가 발생하면 오류를 설명하는 경고 메시지를 발행하고 시도합니다.
계속해서 문서를 생성합니다.

가져오기 오류는 epydoc이 모듈을 가져올 수 없음을 나타냅니다. 가져오기 오류는 일반적으로
해당 모듈에 대한 문서를 epydoc에서 생성하지 못하도록 합니다. Epydoc은
다음의 가져오기 오류를 생성합니다:

나쁜 모듈 name 모듈
Epydoc이 가져오기를 시도했습니다. 모듈하지만, 모듈 Python에 대한 유효한 이름이 아닙니다.
기준 치수.

수 지원 발견 a UID 을 통한 링크 타겟
Epydoc은 인라인 링크 구성에서 참조하는 객체를 찾을 수 없습니다.
(엘{...}). 이는 일반적으로 링크의 오타로 인해 발생합니다.

수 지원 import 모듈
Epydoc이 가져오기를 시도했습니다. 모듈, 그러나 실패했습니다. 이것은 일반적으로 다음과 같은 경우에 발생합니다.
모듈 예외가 발생합니다.

파일 하지 지원 있다
Epydoc은 다음에 포함된 모듈을 가져오려고 시도했습니다. 파일하지만, 파일 하지 않습니다
있다.

Epytext 오류는 잘못된 마크업을 포함하는 epytext 문서 문자열로 인해 발생합니다.
epytext 오류가 감지되면 해당 docstring은 일반 텍스트 docstring으로 처리됩니다.
Epydoc은 다음과 같은 epytext 오류를 생성할 수 있습니다.

나쁜 링크 대상입니다.
인라인 링크 구성에 대해 지정된 대상(엘{...}) 좋지 않다-
형성. 링크 대상은 유효한 Python 식별자여야 합니다.

나쁜 의 대상입니다.
인라인 URI 구성에 대해 지정된 대상(유{...}) 형식이 올바르지 않습니다.
이는 일반적으로 인라인 마크업이 URI 대상 내에 중첩된 경우에 발생합니다.

Fields 절대로 필요한 것 be at 전에, 상단 수평.
필드 목록(@param등)은 다른 블록 구조에 포함되어 있습니다.
(예: 목록 또는 섹션).

Fields 절대로 필요한 것 be 전에, 최후의 집단.
필드 목록(@param등)이 docstring의 끝에 있지 않습니다.

제목 절대로 필요한 것 발생 at 상단 수평.
제목은 다른 블록 구조(예: 목록)에 포함됩니다.

부적절한 독테스트 블록 들여 쓰기.
doctest 블록은 초기 프롬프트 행의 들여쓰기를 지나 내어씁니다.

부적절한 표제 들여 쓰기.
섹션의 제목이 섹션의 단락과 왼쪽 정렬되지 않습니다.
포함하는 섹션입니다.

부적절한 절 들여 쓰기.
블록 내의 단락은 왼쪽 정렬되지 않습니다. 이 오류는 종종
일반 텍스트 docstring이 epytext를 사용하여 구문 분석될 때 생성됩니다.

잘못된 탈출.
알 수 없는 이스케이프 시퀀스가 ​​인라인 이스케이프 구성과 함께 사용되었습니다.
(이자형{...}).

기울기 절대로 필요한 것 be 들여쓰기.
단락 바로 뒤에 오는 들여쓰기되지 않은 줄은 목록 글머리 기호로 시작합니다.
Epydoc은 사용자가 새 목록 항목을 시작하려고 했는지 또는
글머리 기호처럼 보이는 단어를 포함하는 단락. 의도했다면
그런 다음 목록을 들여씁니다. 후자를 의도했다면 다음을 변경하십시오.
단락의 자동 줄 바꿈 또는 해당 단어의 첫 번째 문자를 이스케이프 처리
총알처럼 보입니다.

불안정한 '{'.
독스트링에 균형이 맞지 않는 중괄호가 포함되어 있습니다. Epytext는 모든 중괄호가
균형을 이루어야 합니다. 단일 불균형 중괄호를 포함하려면 이스케이프를 사용하십시오.
시퀀스 E{lb}(왼쪽 중괄호) 및 E{rb}(오른쪽 중괄호).

불안정한 '}'.
독스트링에 균형이 맞지 않는 중괄호가 포함되어 있습니다. Epytext는 모든 중괄호가
균형을 이루어야 합니다. 단일 불균형 중괄호를 포함하려면 이스케이프를 사용하십시오.
시퀀스 E{lb}(왼쪽 중괄호) 및 E{rb}(오른쪽 중괄호).

알 수 없는 인라인 마크 업 꼬리표.
인라인 마크업 구성( x{...} ).

잘못된 밑줄 문자 을 통한 표제.
이 섹션 제목에 사용된 밑줄 문자는
적절한 섹션 수준. "=" 문자는 밑줄을 긋는 데 사용해야 합니다.
섹션; 하위 섹션의 경우 "-"; 하위 섹션의 경우 "~".

Epytext 경고는 의심스럽거나 의심스러운 내용을 포함하는 epytext 문서 문자열로 인해 발생합니다.
마크업. Epytext 경고는 지원 문제의 docstring이 구문 분석되는 것을 방지합니다.
Epydoc은 다음과 같은 epytext 경고를 생성할 수 있습니다.

가능한 잘못된 형식 들 목.
Epytext가 필드 항목처럼 보이지만 올바르지 않은 행을 감지했습니다.
포맷. 일반적으로 후행 콜론(":")이 포함되지 않은 경우에 발생합니다.
필드 태그에서.

가능한 표제 오식.
Epytext는 제목처럼 보이는 한 쌍의 줄을 감지했지만
밑줄 문자가 제목의 문자 수와 일치하지 않습니다.
이 두 줄의 문자 수는 정확하게 일치해야 합니다.
제목으로 간주됩니다.

필드 경고는 잘못된 필드를 포함하는 epytext docstring으로 인해 발생합니다. 콘텐츠
무효한 필드의 경우 일반적으로 무시됩니다. Epydoc은 다음 필드를 생성할 수 있습니다.
경고 :

@param 을 통한 알 수없는 매개 변수 내 돈.
매개변수 유형을 지정하는 데 @param 필드가 사용되었습니다.
함수의 서명에 포함됩니다. 이것은 일반적으로 오타로 인해 발생합니다.
매개변수 이름.

태그 한 지원 기대 an 논의.
필드 태그 태그 인수와 함께 사용되었지만 인수를 사용하지 않습니다.

태그 기대하는 an 논의.
필드 태그 태그 인수 없이 사용되었지만 인수가 필요합니다.

@유형 을 통한 알 수없는 매개 변수 내 돈.
포함되지 않은 매개변수의 유형을 지정하는 데 @type 필드가 사용되었습니다.
함수의 서명에서. 이것은 일반적으로
매개변수 이름.

@유형 을 통한 알 수없는 변수 였다.
@type 필드는 변수의 유형을 지정하는 데 사용되었지만 다른 유형은 지정하지 않았습니다.
변수에 대한 정보가 알려져 있습니다. 이것은 일반적으로 오타로 인해 발생합니다.
변수 이름.

알 수 없는 들 태그 태그.
독스트링에 알 수 없는 태그가 있는 필드가 포함되어 있습니다. 태그.

재정의 of 들.
여러 필드 태그는 다음 값을 정의합니다. 들 같은 docstring에 있지만 들
단일 값만 사용할 수 있습니다.

epydoc가 검사를 시도하는 동안 문제가 발생하면 검사 오류가 생성됩니다.
문서화된 객체의 속성. 대부분의 검사 오류는 epydoc을 방지하지 못합니다.
문제의 객체를 문서화하는 것에서. Epydoc은 다음 검사를 생성할 수 있습니다.
오류 :

The 매개 변수 of 방법 do 지원 일치 기본 방법.
문서화되지 않은 메서드의 매개변수 방법 매개변수와 일치하지 않습니다
기본 클래스 메서드의 기본 방법 그것이 무시된다는 것입니다. 그 결과, 방법
문서를 상속하지 않습니다 기본 방법. 차이가 있다면
매개변수가 의도적인 것이라면 경고를 제거하려면 다음을 추가하면 됩니다.
(아마도 비어 있을) docstring 방법.

문서맵 더하다 a 유형
Epydoc은 알 수 없는 유형의 객체를 문서화하려고 시도했습니다. 이 오류는
일반적으로 가져오기를 조작하는 패키지 및 모듈에 의해 생성됩니다.
모듈을 가져오면 다른 유형의 객체가 생성되는 메커니즘입니다.

UID 갈등 감지됨: UID
두 개의 다른 객체는 epydoc에 의해 동일한 고유 식별자를 할당받았습니다.
epydoc이 한 객체의 문서를 다른 객체로 대체할 수 있도록 할 수 있습니다.
동일한 고유 식별자가 할당된 다른 객체에 대한 문서입니다.
그러나 이것은 일반적으로 동일한 두 객체가 있는 경우에만 문제를 일으킵니다.
고유 식별자는 모듈 또는 클래스 모두이며 이 경우 API
한 개체에 대한 설명서 페이지는 API 설명서 페이지를 덮어씁니다.
다른 대상.

대상 등장하다 in 여러 내장 모듈
내장 객체를 정의하는 모듈을 판별하려고 시도하는 동안 대상,
epydoc은 여러 후보자를 만났고 어떤 후보자를 선택할지 결정할 수 없었습니다.
후보자가 옳았습니다. 이 경우, epidoc은 임의로 첫 번째를 선택합니다.
발견된 후보입니다.

대상 등장하다 in 여러 .py 모듈
내장 객체를 정의하는 모듈을 판별하려고 시도하는 동안 대상,
epydoc은 여러 후보자를 만났고 어떤 후보자를 선택할지 결정할 수 없었습니다.
후보자가 옳았습니다. 이 경우, epidoc은 임의로 첫 번째를 선택합니다.
발견된 후보입니다.

대상 등장하다 in 여러 .그래서 모듈
내장 객체를 정의하는 모듈을 판별하려고 시도하는 동안 대상,
epydoc은 여러 후보자를 만났고 어떤 후보자를 선택할지 결정할 수 없었습니다.
후보자가 옳았습니다. 이 경우, epidoc은 임의로 첫 번째를 선택합니다.
발견된 후보입니다.

수 지원 발견 a 모듈 을 통한 대상
Epydoc은 어떤 모듈이 정의되어 있는지 확인할 수 없습니다. 대상. 면 대상 하는
기능을 사용하면 epydoc이 문서를 생성하지 못하게 됩니다.
대상어떤 페이지에 설명서를 넣어야 할지 모르기 때문입니다.
그렇지 않으면 문서화가 방해됩니다. 대상 링크를 포함하는 것에서
해당 모듈을 포함합니다.

onworks.net 서비스를 사용하여 epydocgui를 온라인으로 사용하세요