728x90
Sphinx는 Python 프로젝트의 문서화를 위한 강력한 도구
주로 코드 기반 문서화에 사용되며, Python 코드의 docstrings과 함께 사용하여 API 문서를 생성하는 데 특히 유용함
프로젝트의 사용법, 모듈, 클래스, 함수 등에 대한 자동화된 문서를 생성할 수 있음
sphinx를 이용하여 만든 docs를 readthedocs.org에 배포하면 docs를 온라인에 공개 가능함
많은 오픈소스는 위와 같은 방법으로 docs를 공개하고 있음
sphinx를 이용한 docs 생성 및 배포 방법은 아래 블로그에서 쉽게 설명하고 있음
https://hooni-playground.com/1101/
Sphinx / Read-the-Docs를 통한 Python Project 문서화 | Hooni's Playground
개발과 문서가 따로노니 신경쓸 것이 두 배로 생긴다. 이에 소스코드로부터 개발문서를 만들어보기로 했다. Sphinx란 Python을 위한 문서화 라이브러리로 소스코드로부터 문서(html, LaTeX 등)를 정적
hooni-playground.com
sphinx
728x90
'Python' 카테고리의 다른 글
| Python 날짜 시간 데이터 다루기 (feat. pandas) (1) | 2024.04.12 |
|---|---|
| Python 날짜 시간 다루기 (feat. datetime) (0) | 2024.04.12 |
| Python 문서화 (feat. PEP 257) (0) | 2024.04.11 |
| Python ZeroMQ (0) | 2024.04.11 |
| asyncio를 이용한 Python 비동기 프로그래밍 (0) | 2024.04.10 |