728x90
반응형
SMALL
프로젝트 및 개발 환경 설정
새 디렉터리에서 다음 내용으로 README.rst라는 파일을 만든다.
Lumache
=======
**Lumache** (/lu'make/) is a Python library for cooks and food lovers that
creates recipes mixing random ingredients.Python 가상 환경을 만들고 필요한 도구를 설치하기에 좋다. 방금 생성한 디렉터리로 명령줄 터미널을 열고 다음 명령을 실행한다.
python -m venv .venv
$ source .venv/bin/activate
(.venv) $ python -m pip install sphinx
올바르게 실행했다면 Sphinx 명령줄 도구를 사용할 수 있어야 한다. 다음 명령을 실행하여 기본 확인을 수행할 수 있다.
$ sphinx-build --version
sphinx-build 4.0.2
위와 유사한 출력이 표시되면 올바른 경로에 있는 것이다.
https://www.sphinx-doc.org/en/master/tutorial/index.html
Sphinx tutorial — Sphinx documentation
Sphinx tutorial In this tutorial you will build a simple documentation project using Sphinx, and view it in your browser as HTML. The project will include narrative, handwritten documentation, as well as autogenerated API documentation. The tutorial is aim
www.sphinx-doc.org
728x90
반응형
LIST
'Python Library' 카테고리의 다른 글
| [Sphinx] Sphinx를 사용하여 프로젝트 문서화 (1) (0) | 2022.05.02 |
|---|---|
| [Sphinx] 시작하기 (문서 레이아웃 만들기) (2) (0) | 2022.05.02 |
| [Sphinx] 코드 문서에서 주의할 점 (0) | 2022.05.02 |
| Sphinx (0) | 2022.05.02 |
| PyWavelet (0) | 2022.04.21 |
