Sphinx로 Python 문서화하기

Sphinx를 사용하면 파이썬 .py 파일 자체를 문서화 할 수 있다.

파이썬 파일 안에 주석으로 입력한 내용들이 자동으로 정리되고 html 파일로 확인 할 수 있다.

 

 

설치

Sphinx를 사용하기 위해서 Sphinx 라이브러리가 필요하다.

>>> pip install sphinx

 

 

문서화 시작

문서화 할 프로젝트의 루트 경로에 위치, 아래와 같이 입력

>>> mkdir docs

 

생성한 docs파일에 들어가서 문서화 진행

>>> cd docs

 

터미널 창에 아래와 같이 입력

>>> sphinx-quickstart

 

아래와 같이 진행

Welcome to the Sphinx 1.3.1 quickstart utility.

Please enter values for the following settings (just press Enter to
accept a default value, if one is given in brackets).

Enter the root path for documentation.
> Root path for the documentation [.]: docs/

You have two options for placing the build directory for Sphinx output.
Either, you use a directory "_build" within the root path, or you separate
"source" and "build" directories within the root path.
> Separate source and build directories (y/n) [n]:

Inside the root directory, two more directories will be created; "_templates"
for custom HTML templates and "_static" for custom stylesheets and other static
files. You can enter another prefix (such as ".") to replace the underscore.
> Name prefix for templates and static dir [_]:

The project name will occur in several places in the built documentation.
> Project name: my_package
> Author name(s): ssut

Sphinx has the notion of a "version" and a "release" for the
software. Each version can have multiple releases. For example, for
Python the version is something like 2.5 or 3.0, while the release is
something like 2.5.1 or 3.0a1. If you don't need this dual structure,
just set both to the same value.
> Project version: 1.0
> Project release [1.0]:

If the documents are to be written in a language other than English,
you can select a language here by its language code. Sphinx will then
translate text that it generates into that language.

For a list of supported codes, see
http://sphinx-doc.org/config.html#confval-language.
> Project language [en]:

The file name suffix for source files. Commonly, this is either ".txt"
or ".rst". Only files with this suffix are considered documents.
> Source file suffix [.rst]:

One document is special in that it is considered the top node of the
"contents tree", that is, it is the root of the hierarchical structure
of the documents. Normally, this is "index", but if your "index"
document is a custom template, you can also set this to another filename.
> Name of your master document (without suffix) [index]:

Sphinx can also add configuration for epub output:
> Do you want to use the epub builder (y/n) [n]:

Please indicate if you want to use one of the following Sphinx extensions:
> autodoc: automatically insert docstrings from modules (y/n) [n]: y
> doctest: automatically test code snippets in doctest blocks (y/n) [n]:
> intersphinx: link between Sphinx documentation of different projects (y/n) [n]: y
> todo: write "todo" entries that can be shown or hidden on build (y/n) [n]: y
> coverage: checks for documentation coverage (y/n) [n]:
> pngmath: include math, rendered as PNG images (y/n) [n]:
> mathjax: include math, rendered in the browser by MathJax (y/n) [n]:
> ifconfig: conditional inclusion of content based on config values (y/n) [n]:
> viewcode: include links to the source code of documented Python objects (y/n) [n]: y

A Makefile and a Windows command file can be generated for you so that you
only have to run e.g. `make html' instead of invoking sphinx-build
directly.
> Create Makefile? (y/n) [y]:
> Create Windows command file? (y/n) [y]:

Creating file docs/conf.py.
Creating file docs/index.rst.
Creating file docs/Makefile.
Creating file docs/make.bat.

Finished: An initial directory structure has been created.

You should now populate your master file docs/index.rst and create other documentation
source files. Use the Makefile to build the docs, like so:
make builder
where "builder" is one of the supported builders, e.g. html, latex or linkcheck.

 

코드 수정

conf.py 파일에서 해당 부분을 아래와 같이 수정한다.

 

import os
import sys
sys.path.insert(0, os.path.abspath('..'))

주석처리를 없애고

경로를 '..'으로 수정한다.

 

깔끔한 테마를 사용하고 싶다면 테마를 설치, 설정을 변경한다.

>>> pip install sphinx_rtd_theme

conf.py 파일에서 설정 변경

html_theme = 'sphinx_rtd_theme'

 

index.rst 파일에서 해당 부분을 아래와 같이 수정한다.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   modules

modules를 추가로 입력하고 저장

 

 

html 만들기

위 과정이 모두 끝났으면 rst파일을 생성해준다.

>>> sphinx-apidoc -o . ..

 

html 파일 만들기

>>> make html

 

프로젝트폴더 > docs > _build 폴더 안에 'html' 가 생성된다.

 

 

 

 

---

 

참고

python-sphinx - 파이썬 - 스핑크스 시작하기 | python-sphinx Tutorial