easy_install Sphinx

sphinx-quickstart

Welcome to the Sphinx 1.0.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 [.]:
ドキュメントのルートパスを指定。Djangoの場合はプロジェクトルートと同じにしたいので、"."のまま。
 
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]:
sourceディレクトリとbuildディレクトリを分けるかどうか。なんとなく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 [_]:
テンプレートディレクトリとstaticファイルディレクトリのprefix。デフォルトのまま"_"にした。
 
The project name will occur in several places in the built documentation.
* Please enter some text.
> Project name: test
> Author name(s): 
自分の名前とかメンバーの名前。
 
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]: 1.0
リリースバージョン。
バージョン変更は、このコマンドが終了したときに作成されるconf.pyに設定されている値を変更すればいいはず。
 
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]:
reSTファイルの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]: 
ドキュメントのルートツリーとなるマスターファイルのファイル名。デフォルトのままindex(index.rst)にした。
 
Sphinx can also add configuration for epub output:
> Do you want to use the epub builder (y/N) [n]:
epubビルダーを使うかどうか。使わないので、デフォルトのままnにした。
 
Please indicate if you want to use one of the following Sphinx extensions:
> autodoc: automatically insert docstrings from modules (y/N) [n]:
autodocを使用して、docstringからドキュメントを出力するかどうか。これがやりたいので、Yにした。
 
> doctest: automatically test code snippets in doctest blocks (y/N) [n]:
doctestを使用するかもしれないので、Yにした。
 
> intersphinx: link between Sphinx documentation of different projects (y/N) [n]:
別プロジェクトに対し、Sphinxドキュメント間でリンクを張るかどうか。使うかもしれないので、Yにした。
 
> todo: write "todo" entries that can be shown or hidden on build (y/N) [n]:
//TODO: みたいにtodoをドキュメントに出力するかどうか。とりあえずYで。
 
> coverage: checks for documentation coverage (y/N) [n]:
ドキュメントのカバレッジをチェックするかどうか。とりあえずYで。
 
> pngmath: include math, rendered as PNG images (y/N) [n]:
> jsmath: include math, rendered in the browser by JSMath (y/N) [n]:
mathモジュールを読み込んで、出力するかどうか。使わないと思うので、nで、
 
> ifconfig: conditional inclusion of content based on config values (y/N) [n]:
ドキュメント出力制御のために条件文(ifconfig)を使うかどうか。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]:
Makefileとバッチファイルを作成するかどうか。どちらもYで。
 
Finished: An initial directory structure has been created.
 
You should now populate your master file .\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 : Sphinx用の設定ファイル。
index.rst : マスターファイル。
make.bat : make用バッチファイル。
Makefile : make。
_build : ビルドディレクトリ。
_static : staticリソース用ディレクトリ。
_templates : templateファイル用ディレクトリ。

sphinx-build -a -b html . .\doc

.doctree
doc

.. automodule:: module_name

# -- General configuration -----------------------------------------------------
keep_warnings = True
autodoc_default_flags = ['members', 'undoc-members', 'show-inheritance']

.. todolist:: 

def hello(msg):
    """
    こんにちわ。
    
    :param string msg: 出力するメッセージ
    """
    print msg
 
def add(a, b):
    """
    足し算ぐらいできます。
    
    :param int a: 足される値。
    :param int b: 足す値。
    :rtype: int
    :return: 足し算した数値。
    :todo: sample.py/def add - 例外出たときどうするんだろ。誰か直しといて。
    """
    return a + b