Python 개발의 문서화 도구 Sphinx 사용해보기

PytorchKR 레포지토리 기여 중에 Sphinx에 대해 알게되었다

 

자세한 활용은 해보지 않았으니 생략하고 이런게 있다는 느낌정도만 가져가자고

 

Sphinx는 Python 프로젝트를 문서화하는 라이브러리인데

 

pip install sphinx로 설치 가능

 

!pip install sphinx

 

 

sphinx로 작성하는 문서는 rst파일로 되어있는데 고쳐야하는 부분을 고치면 된다

 

다행히 python 코드가 입력되는 부분은... code :: python으로 되어있고 python 문법을 따르더라고

 

 

 

 

다음 빌드를 위해 sphinx-quickstart를 입력

 

설명에 따라 입력해주면 되는데 소스 코드와 빌드 경로를 분리할건지 아닌지?

 

기본값은 n이라네

 

 

 

그 외에 프로젝트 이름이나 작가 이름, 버전, 프로젝트 언어 등을 입력하라고 함

 

 

 

그러면 프로젝트 폴더 내에 여러 폴더 파일들이 생기는데

 

 

 

 

torchvision_tutorial.rst 파일이 소스파일인데 처음에 소스파일과 빌드 폴더를 분리하지 않아서.. 같이 있다

 

아무튼 빌드할려면 make html

 

근데 이렇게 커맨드를 못찾는다고 나온다면

 

 

 

sphinx-build (source파일이 있는 폴더 경로) (빌드한 html 폴더를 위치시킬 경로)

 

sphinx-build . _build

 

 

 

 

그러면 _build 폴더 내부에 다음과 같이 여러 파일들이 생다

 

 

 

index.html 들어가면

 

 

 

빌드한 html 파일 들어가본다면