Python製ドキュメンテーションビルダー「Sphinx」をCentOS7に30分でインストールする。

環境

OS: CentOS Linux 7 (Core)
VCPU: 2
MEM: 2GB
Python: 2.7.5

手順

1.Yumリポジトリを追加
2.Pythonのライブラリ管理ツールのインストールとアップデート
3.Sphinxのインストールとバージョンの確認
4.Sphinxのプロジェクトを作成
5.HTMLファイルを生成
6.Markdown記法に対応
7.テーマを変更

1.Yumリポジトリとパッケージを追加

# yum install -y epel-release make gcc
# yum upgrade

2.Pythonのライブラリ管理ツールのインストールとアップデート

# yum install -y python-pip python-devel
# pip install --upgrade pip

3.Sphinxのインストールとバージョンの確認

Sphinxをインストール。

# pip install sphinx sphinx-autobuild

インストールしたSphinxのバージョンを確認。

# sphinx-quickstart --version
Sphinx v1.6.2

4.Sphinxのプロジェクトを作成(公式マニュアル)

作業ディテクトを作成し、sphinx-quickstartコマンドを実行する。

# mkdir firstproject
# cd firstproject
# sphinx-quickstart
Welcome to the Sphinx 1.6.2 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 [.]:

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]: y

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: firstproject
> Author name(s): hoge

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 []: 0.1
> Project release [0.1]:

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]: ja

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]:
> doctest: automatically test code snippets in doctest blocks (y/n) [n]:
> intersphinx: link between Sphinx documentation of different projects (y/n) [n]:
> todo: write "todo" entries that can be shown or hidden on build (y/n) [n]:
> coverage: checks for documentation coverage (y/n) [n]:
> imgmath: include math, rendered as PNG or SVG 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]:
> githubpages: create .nojekyll file to publish the document on GitHub pages (y/n) [n]:

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 ./source/conf.py.
Creating file ./source/index.rst.
Creating file ./Makefile.
Creating file ./make.bat.

Finished: An initial directory structure has been created.

You should now populate your master file ./source/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.

5.HTMLファイルを生成

make htmlコマンドでHTMLファイルを生成する。

# make html
Running Sphinx v1.6.2
making output directory...
loading translations [ja]... 完了
保存された環境データを読み込み中...まだ作られていません
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 1 source files that are out of date
updating environment: 1 added, 0 changed, 0 removed
reading sources... [100%] index
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] index
generating indices... genindex
writing additional pages... search
copying static files... done
copying extra files... done
dumping search index in Japanese (code: ja) ... done
dumping object inventory... done
ビルド 成功.

Build finished. The HTML pages are in build/html.

正常に終了した場合は、build/htmlにHTMLファイルが生成されてる。

# ls build/html
genindex.html  index.html  objects.inv  search.html  searchindex.js  _sources  _static

6.Markdown記法に対応

.rstだけでなく、.mdにも対応させるため、ライブラリをインストールする。

# pip install recommonmark

conf.pyの38行目あたりの、下記設定を編集する。

# vim source/conf.py

編集前

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'

編集後

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
from recommonmark.parser import CommonMarkParser

source_parsers = {
    '.md': CommonMarkParser,
}
source_suffix = ['.rst', '.md']

Markdown記法のファイルを作成

# vim source/markdown.md

内容

# test title

## test title

### test title

#### test title

[Google.com リンク](https://www.google.co.jp)

あとは、普段通りindex.rstmarkdown.mdが追記するだけ。

vim source/index.rst
Welcome to Test's documentation!
==================================

.. toctree::
   :maxdepth: 2

   markdown

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
EOF

7.テーマを変更(readthedocs)

テーマをインストールする。

# pip install sphinx_rtd_theme

conf.pyの html_theme を編集する。

# vim souce/conf.py

編集前

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'

編集後

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
#
html_theme = "sphinx_rtd_theme"

Nginxをインストー

Sphinxで生成したHTMLを公開する場合は、Nginxをインストールする。

# yum install -y nginx

Nginxのドキュメントルートにfirstprojectディレクトリをコピーする。

cp -af build/html /usr/share/nginx/html/firstproject

Nginxを起動する。

# systemctl restart nginx

Firewalldを利用している場合は、httpサービスを許可リストに追加する。

# firewall-cmd --add-service=http --permanent
# firewall-cmd --reload

ブラウザからアクセスする。

http://<IPアドレス>/firstproject