nb autodoc

NB-Autodoc

중국 영어 단순화

소개

NB-Autodoc은 Python 소스 코드 유형 주석 및 문서화에서 API 문서를 자동으로 생성하는 도구입니다.

이 도구는 패키지에서 모든 모듈을 찾아 가져오고 가져 오기, 초록 구문 트리, 각 모듈의 런타임 유형, 링크 내부 객체, 함수 서명 및 문서 구문 트리를 구문 분석하고 완전하고 신뢰할 수 있으며 링크 기반 API 문서를 생성합니다.

주요 기능

• AST 기반 유형 분석 시스템

• X | Y 와 같은 현대 장르 디스플레이 X | Y , list[str] , (*args) -> Any

• 스터브 (.Pyi) 지원

• 유형 _checking 지원

• 지원, AST의 수입 참조

• 과부하 오버로드 기능 지원

용법

PIP에서 설치 :

 pip install nb-autodoc

NB-Autodoc 실행 :

 nb-autodoc {package_name}

기타 명령 줄 옵션 :

 Usage: nb-autodoc [OPTIONS] MODULE

Options:
  -o, --output-dir DIRECTORY      [default: build]
  -s, --skip TEXT                 skip import modules
  -u, --undoc TEXT                undocument modules
  --markdown-linkmode [heading_id|vuepress]
                                  [default: heading_id]
  --help                          Show this message and exit.

팁 : -스크립 대신 --skip 대신 --undoc 사용하면 모듈의 가져 오기 및 분석을 건너 뜁니다.