2
3

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 5 years have passed since last update.

Sphinxの使い方メモ(MacOSX)

Posted at

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
2
3
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
2
3

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?