Posted at

Sphinxの使い方メモ(MacOSX)

Keras Documentationの美しさに感動して、ホームページや自分が書いたアプリの説明書を、Sphinxで作成することにしました。


インストール方法

pipでダウンロードできます。

$ sudo pip3 install sphinx

$ sphinx-quickstart --version
sphinx-quickstart 1.8.5


使い方

まずは、sphinx-quickstartでフォルダを作成します。作成の際に、色々とオプションを聞かれますが、回答必須なものは、プロジェクト名(Project name)と作者(Author name(s))のみです。あとは、適当にイエスで大丈夫です。

$ mkdir work

$ cd work
$ sphinx-quickstart proceedings


編集

作成されたフォルダに含まれているindex.rstをマークダウン記法によって編集してビルドすれば、_build/html/index.htmlにHTML形式に変換されたページができています。

$ make html

$ open _build/html/index.html