[Python] Sphinx 라이브러리 사용법

Sphinx란?

- 파이썬을 위한 문서화 라이브러리

- 소스코드로부터 문서를 정적으로 생성하는 도구

 

 

 

Sphinx 설치방법

- cmd를 통해 가상환경을 생성한 폴더로 경로 지정 후, 가상환경 내에 아래 명렁어를 입력함

$ pip install Sphinx

 

 

 

Sphinx 시작하기

- 가상환경 폴더 내에 docs라는 폴더를 생성한 다음, 그 폴더에서 sphinx를 시작함

- sphinx-quickstart : 스핑크스 시작하는 명령어

$ mkdir docs
$ cd docs
$ sphinx-quickstart

- 위의 코드를 실행한 후, 

- Separate source and build direcories (y/n) [n]:

- 이라는 코드가 생성되며, 이 코드의 의미는 source와 build 폴더를 별도로 관리할 지 하나로 관리할 지에 대한 선택

- source 폴더는 우리가 작성한 코드가 되고,

- build 폴더는 우리가 작성한 코드를 html, css, js로 변환된 파일이 저장되는 공간

 

 

 

빌드 (html 생성)

- source에 있는 파일을 html 결과파일로 바꿔주는 명령어

- make.bat이 생성된 root 경로에서 실행

$ make html

- 그 후 build/html/index.html 파일을 열면, 코드가 문서화된 내용이 html로 보임

 

 

 

스핑크스 테마 설치 & 설치한 테마 적용

- 테마 설치 명령어

$ pip install 테마이름

- source/conf.py 를 열어서 html_theme = '설치한 테마이름' 으로 저장하면 됨

- 그 후 make html 명령어를 실행시킨 후 index.html 파일을 열어서 테마 적용을 확인할 수 있음