Python - 문서화 도구 Sphinx
Sphinx 는 python의 대표적인 문서화 도구로 reStructedText 또는 Markdown 문서를 HTML, pdf, man page 등의 결과물로 생성할 수 있다.
sphinx 설치
sphinx 는 python 환경에서 실행이 된다. 설치는 python 환경 혹은 OS 환경에 직접 설치하는 방법이 있다. 파이썬 가상환경을 권장한다.
https://www.sphinx-doc.org/en/master/usage/installation.html
- Python 환경에 설치
python 환경 혹은 python 가상환경 (venv, virtualenv 등)에 설치
pip
1 | pip install sphinx |
Anaconda
1 | conda install sphinx |
- 시스템에 직접 설치
각 OS 의 SW 로 설치한다면 package 관리자를 사용해 설치한다.
Debian/Ubuntu
1 | apt install python3-sphinx |
RHEL, CentOS
1 | yum install python-sphinx |
macOS / home-brew
1 | brew install sphinx-doc |
Python - 문서화 도구 Sphinx