sphinx-quickstart

概要

sphinx-quickstart

説明

sphinx-quickstart はいくつかの質問であなたのプロジェクトを生成するためのディレクトリと sphinx-build(1) と一緒に使えるサンプルMakefileを作成してくれるインタラクティブなツールです。

オプション

-q, --quiet

Quiet mode that will skip interactive wizard to specify options. This option requires -p, -a and -v options.

-h, --help, --version

簡単な使い方やSphinxのバージョンを表示します。

Structure Options

--sep

記述した場合、ソースとビルドのディレクトリを分割します。

--dot=DOT

プロジェクトのルートディレクトリに 2以上のディレクトリが作成されます。カスタマイズしたHTMLテンプレート用の"_templates"ディレクトリと、カスタマイズしたスタイルシート等を置く"_static"ディレクトリがあります。これらのディレクトリは "_" で始まっていますが、別の文字("."など)で始まるように指定できます。

Project Basic Options

-p PROJECT, --project=PROJECT

プロジェクト名を指定します ( project も参照)。

-a AUTHOR, --author=AUTHOR

著者名を指定します。 ( copyright も参照)。

-v VERSION

プロジェクトのバージョンを指定します ( version も参照)。

-r RELEASE, --release=RELEASE

プロジェクトのリリースを指定します ( release も参照)。

-l LANGUAGE, --language=LANGUAGE

ドキュメント言語。 ( language 参照 )

--suffix=SUFFIX

ソース・ファイルサフィックス。 ( source_suffix 参照)

--master=MASTER

マスタードキュメント名。 ( master_doc 参照)

Extension Options

--ext-autodoc

sphinx.ext.autodoc 拡張を有効にします。

--ext-doctest

sphinx.ext.doctest 拡張を有効にします。

--ext-intersphinx

sphinx.ext.intersphinx 拡張を有効にします。

--ext-todo

sphinx.ext.todo 拡張を有効にします。

--ext-coverage

sphinx.ext.coverage 拡張を有効にします。

--ext-imgmath

sphinx.ext.imgmath 拡張を有効にします。

--ext-mathjax

sphinx.ext.mathjax 拡張を有効にします。

--ext-ifconfig

sphinx.ext.ifconfig 拡張を有効にします。

--ext-viewcode

sphinx.ext.viewcode 拡張を有効にします。

--ext-githubpages

Enable sphinx.ext.githubpages extension.

--extensions=EXTENSIONS

Enable arbitrary extensions.

Makefile and Batchfile Creation Options

--use-make-mode (-m), --no-use-make-mode (-M)

Makefile/make.bat uses (or doesn't use) make-mode. Default is use, which generates a more concise Makefile/make.bat.

バージョン 1.5 で変更: make-mode is default.

--makefile, --no-makefile

makefileの作成 (もしくは非作成)

--batchfile, --no-batchfile

batファイルの作成 (もしくは非作成)

プロジェクトテンプレート

バージョン 1.5 で追加: Project templating options for sphinx-quickstart

-t, --templatedir=TEMPLATEDIR

Template directory for template files. You can modify the templates of sphinx project files generated by quickstart. Following Jinja2 template files are allowed:

  • master_doc.rst_t

  • conf.py_t

  • Makefile_t

  • Makefile.new_t

  • make.bat_t

  • make.bat.new_t

In detail, please refer the system template files Sphinx provides. (sphinx/templates/quickstart)

-d NAME=VALUE

Define a template variable

参考

sphinx-build(1)