Sphinxをはじめよう¶
Sphinxを使って、かんたんな書籍紹介のドキュメントを作っていきます。
Sphinxのインストール¶
SphinxはPythonで書かれているため、Sphinxのインストールにあたっては、Pythonのセットアップと、Sphinxのインストールの両方が必要になります。
プロジェクトの作成¶
Sphinxでドキュメントを作るには、まずはドキュメントのプロジェクトを作ります。 Ruby on Rails のScaffoldや、 Django のプロジェクトと似ていて、コマンドラインから、いくつかの質問に答えるとできあがります。
このひな形の作成と、ドキュメントのツリー構造の説明を行っていきます。
表、リストなどを追加して完成させる¶
Sphinxでは、reStructuredTextという、Wikiに似た簡易テキストマークアップを利用してドキュメントを作っていきます。ここでは、良く使うマークアップの紹介を行っていきます。
ディレクティブの紹介¶
reStructuredTextに実装されているディレクティブについて紹介します。