プロジェクトを作ってみよう

まず、エクスプローラで適当に作業用フォルダを作ります。

作業用フォルダをエクスプローラで開いて、SHIFTキーを押しながらマウスを右クリックすると、メニューの中に「PowerShellウィンドウをここに開く」という項目が現れます。この項目を選んでPowerShellウィンドウを開くと、このフォルダに入った状態でPowerShellウィンドウが開きます。

../_images/build_project_01.png

このままPowerShellウィンドウで作業しても良いのですが、以前のコマンドプロンプトの方が良ければcmdと入力するとコマンドプロンプトに切り替わります。

../_images/build_project_02.png

それでは、このフォルダでプロジェクトを作りましょう。 sphinx-quickstartと入力してください。

c:\Users\作業中\trial> sphinx-quickstart

プロジェクトの設定が対話形式で行われます。全て入力が終わると、プロジェクトに必要なファイルが作成されます。

行頭に>マークが付いているところが、入力が必要なところです。

C:\Users\作業中\trial>sphinx-quickstart
Welcome to the Sphinx 1.5.6 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: trial
> Author name(s): trial_author

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.0.0
> Project release [0.0.0]: 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]: 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 .\conf.py.
Creating file .\index.rst.
Creating file .\Makefile.
Creating file .\make.bat.

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.

といっても、実際に入力したのは下記の項目だけで、他はデフォルトのまま（RETURNキーを押すだけ）にしました。

  • Project name
  • Author name(s)
  • Project version
  • Project release
  • Project language

悩む項目はありませんよね。

対話形式でのプロジェクトの作成が終わると自動的にファイルが生成されて、フォルダの構成はこのような感じになります。

c:\Users\作業中\trial
│  conf.py
│  index.rst
│  make.bat
│  Makefile
│
├─_build
├─_static
└─_templates