Sphinx 는 python의 대표적인 문서화 도구로 reStructedText 또는 Markdown 문서를 HTML, pdf, man page 등의 결과물로 생성할 수 있다.

sphinx 설치

sphinx 는 python 환경에서 실행이 된다. 설치는 python 환경 혹은 OS 환경에 직접 설치하는 방법이 있다. 파이썬 가상환경을 권장한다.

https://www.sphinx-doc.org/en/master/usage/installation.html

- Python 환경에 설치

python 환경 혹은 python 가상환경 (venv, virtualenv 등)에 설치

pip

1

pip install sphinx

Anaconda

1

conda install sphinx

- 시스템에 직접 설치

각 OS 의 SW 로 설치한다면 package 관리자를 사용해 설치한다.

Debian/Ubuntu

1

apt install python3-sphinx

RHEL, CentOS

1

yum install python-sphinx

macOS / home-brew

1

brew install sphinx-doc

이 글은 github pages 를 통해서 블로그를 할 수 있도록 다음 작업을 한다:

• 로컬에 ruby를 기반으로한 jekyll 을 설치한다.
• github pages 와 연동한다.
• markdown 으로 작성한 문서를 github pages 에 올린다.

jekyll

jekyllrb.com 의 가이드에 따라 github page에서 블로그로 사용하고자 한다.

설치

Ruby 개발 도구가 반드시 필요 - 여기서 macOS 에서 블로그 작업을 한다고 가정한다.

• macOS는 Ruby 최신 버전이 제공되고 있다.
• 여기선 Homebrew 로 루비를 설치하고 사용한다.