備忘録

インストール

$ sudo yum install python-setuptools python-imaging ipa-gothic-fonts
$ sudo easy_install pip 
$ pip install sphinx blockdiag nwdiag seqdiag actdiag


プロジェクトの作成

$ sphinx-quickstart
Welcome to the Sphinx 1.1.3 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]: 

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: hogehoge    ※日本語の場合は u'ほげほげ のようにu''の記載
> Author name(s): foo

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

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

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


作成後

$ ls
Makefile	_static		conf.py		index.rst	src
_build		_templates	export		other


[build]

$ make html
$ cd _build/html/; pwd
$ open index.html     # 初期状態の確認

[日本語化]

$ vi ../../conf.py
language = 'ja'
$ cd ../../; pwd
$ make html
$ open _build/html/index.html   # 日本語化されていること


メモ

[テーマの変更]

config.pyを設定する。デフォルトのテーマを使用して、サイドバーや表示を一部変更する場合はoption指定を追加

html_theme = 'default'
html_theme_options = {
    # ここにオプションを記入
}

テーマごと変更するには、以下記述を行う。

html_theme = <使用したいテーマ>   # 'sphinxdoc' や 'nature' が良さそう。サイドバーが不要なら'haiku'

[コメントアウト]

".. "(ドット、ドット、スペース)

[Windowsパスの記述]

``C:¥¥User¥hoge¥`にする


拡張

[blockdiag, nwdiag]

Sphinxcontrib-(blockdiag|nwdiag) を利用するには conf.py の extensions 変数に指定

extensions = ['sphinxcontrib.blockdiag','sphinxcontrib.nwdiag']


[PDF化]

動作確認していなので、関連URLだけ添付

http://sphinx-users.jp/cookbook/pdf/rst2pdf.html

http://kashewnuts-tech.blogspot.jp/2012/06/restpdf.html

フォントフォルダはMAC(~/Library/Fonts)、Linux(/usr/share/fonts/)