개발 문서 생성기 'Sphinx'

Sphinx 는 python을 사용한 개발 문서 생성하는 프로그램..

(갑자기 doxygen 이 생각남.. -_-)

 

msys2에서 아래와같이.. 설치하고... (파이선은 깔려있다는 가정에..)

% pacman -S mingw-w64-i686-python-sphinx
% pacman -S mingw-w64-i686-python-pip

아래와 같이.. 샘플 문서를 만들어봄..

% mkdir doc
% cd doc
% sphinx-quickstart.exe
% make
% make html

doc/source/conf.py 파일을 열어서.. 아래의 테마를 변경..

html_theme = 'bizstyle'

다시.. 

% make html

이제 확인해봄.. doc/build/html/index.html 파일을 부라우저로 열어봄..

 

추가로.. 적용 가능한 테마는 아래에서 확인 가능..

https://sphinx-themes.org/

 

테마는 아래와 같이 설치하고 conf.py 에서 변경해줌..

% pip install groundwork-sphinx-theme

자세한 사용법은.. 아래를 참고..

https://blog.naver.com/pjt3591oo/222067596734

 

markdown 포맷은 .md 파일을 지원을 위해서는 아래와 같이 모듈을 먼저설치.

pip install recommonmark