sphinxについて

必要になったのでメモ。
※もう半年前のやつですが…
　実際仕事では、バンバン使ってるので

sphinx自体の説明は割愛。
要はドキュメント生成ツールとだけ。
sphinx-users.jp

まずはインストールから。
前段階だが、Pythonをインストールももちろんしておく。
※バージョンは2.7しか知りません。
その際環境変数を追加。

変数名：　Path
変数値：　;C:\Python27;C:\Python27\Scripts

ローカルでパスが通っているか確認の為
コマンドプロンプトで
【python】と入力し
詳細が出るか確認。
エラーが出てなければOK。

続けてsphinxのインストール。
今回はpipで。
コマンドプロンプトで以下のコマンドを実行。

【pip install Sphinx】

仮の場所として、【C:\Python27\Doc】でコマンドプロンプトを開く。

【sphinx-quickstart】
を実行。
するとたくさん質問が出てきます。
それらは一個一個答える必要があります。
詳しくは以下のリンクにて。
http://sphinx-users.jp/gettingstarted/sphinxquickstart.html

その中でも重要なのが
プロジェクト名、名前。
あとは、拡張子の設定でデフォだと
「.rst」となっているところを
「.txt」に設定しておくと便利かも。

で、すべての項目が終わると
開いた階層に、プロジェクト階層ができる。
そこにできる「index.rst or txt」を開きます。
内部のテキストを変更すると、HTMLに反映される感じです。

冒頭の【.. 】以降に書いている
テキストはコメントアウトなので
気になさらず。
重要なのは
Welcome to HelpPage's documentation!
====================================
これでタイトルエリアの設定。

これはタイトルです！
====================================
とするとわかりやすいですね。

次に

.. toctree::
:maxdepth: 2
:caption: Contents:
この部分ですが
まずは【toctree】
これは、子どものタイトル情報を持ってきて、リンクを生成できます。
maxdepthはその階層の深さ。
captionはそのままの意味となります。

まぁとりあえず、うだうだ書いてますが
上記をを踏まえ以下の感じでテストしてみます。

用意ができれば、再度コマンドプロンプトを指定のディレクトリで立ち上げ
以下のコマンドを実行します。

make html
これでビルドされてHTMLが生成されます。

画像とか、動画も貼れるので
HELPとかには、すげぇ使えますね。

以上。

とか書いてますが、正直このレベルは
WEBに腐る程ありますね。

…。