Python・Sphinx・quickstart

mkdir [プロジェクト用ディレクトリ]

cd [プロジェクト用ディレクトリ]

sphinx-quickstart

$ ls -l
total 8
drwxrwxr-x. 2 vagrant vagrant   6 Apr 14 08:32 build
-rw-rw-r--. 1 vagrant vagrant 799 Apr 14 08:32 make.bat
-rw-rw-r--. 1 vagrant vagrant 638 Apr 14 08:32 Makefile
drwxrwxr-x. 4 vagrant vagrant  71 Apr 14 08:32 source

sphinx-quickstartを実行すると、プロジェクト名や著者名などの入力が求めれれます。 質問に応じて入力すると、現在のディレクトリに必要なファイルが作成されます。

例

$ sphinx-quickstart
Welcome to the Sphinx 2.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).

Selected root path: .

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
                

buildディレクトリとソースディレクトリを別にする場合は、'y'を入力します。

The project name will occur in several places in the built documentation.
> Project name: mytest
                

プロジェクト名を入力。上記では、”mytest"。

> Author name(s): nanashi
                

著者名を入力。上記例では、"nanashi"。

> Project release []: 1.0.0
                

リリースバージョン番号を入力します。例えば、"1.0.0" とか、まだ試用版なら "0.1.0"とか。 上記例では"1.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
https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-language.
> Project language [en]: ja
                

言語を入力。日本語の場合は、"ja"を入力

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.

現在のディレクトリに、ファイルとディレクトリが作成されているはずです。

sphinx-quickstartが正常に終了したら、以下のようなファイルとディレクトリが作成されます。

$ ls -l
total 8
drwxrwxr-x. 2 vagrant vagrant   6 Apr 14 08:32 build
-rw-rw-r--. 1 vagrant vagrant 799 Apr 14 08:32 make.bat
-rw-rw-r--. 1 vagrant vagrant 638 Apr 14 08:32 Makefile
drwxrwxr-x. 4 vagrant vagrant  71 Apr 14 08:32 source

buildディレクトリはカラですが、sourceディレクトリの中は以下のようになっています。

$ ls -l source/
total 8
-rw-rw-r--. 1 vagrant vagrant 2150 Apr 14 08:32 conf.py
-rw-rw-r--. 1 vagrant vagrant  434 Apr 14 08:32 index.rst
drwxrwxr-x. 2 vagrant vagrant    6 Apr 14 08:32 _static
drwxrwxr-x. 2 vagrant vagrant    6 Apr 14 08:32 _templates