Sphinx

Sphinx

 

 

Sphinx는 Georg Brandl이 작성하고 BSD 라이선스에 따라 라이선스가 부여된 지능적이고 아름다운 문서를 쉽게 만들 수 있는 도구이다.

 

원래 Python 문서용으로 만들어졌으며 다양한 언어로 된 소프트웨어 프로젝트 문서화를 위한 우수한 기능을 갖추고 있다. 물론 이 사이트도 Sphinx를 사용하여 reStructuredText 소스에서 생성된다. 다음 기능이 강조 표시되어야 한다.

 

출력 형식 : HTML (Windows HTML 도움말 포함), LaTeX (인쇄 가능한 PDF 버전용), ePub, Texinfo, 매뉴얼 페이지, 일반 텍스트 광범위한 상호 참조: 기능, 클래스, 인용, 용어집 및 유사한 정보에 대한 의미론적 마크업 및 자동 링크 계층 구조 : 형제, 부모 및 자식에 대한 자동 링크가 있는 문서 트리의 쉬운 정의 자동 인덱스 : 일반 인덱스 및 언어별 모듈 인덱스 코드 처리 : Pygments 형광펜 을 사용한 자동 강조 표시 확장 : 코드 조각 자동 테스트, Python 모듈(API 문서)의 docstrings 포함 등 기여 확장 : 사용자가 제공한 수십 개의 확장 ; 대부분은 PyPI에서 설치할 수 있다.

 

https://www.sphinx-doc.org/en/master/

Overview — Sphinx documentation