初心者のためSphinx入門-2¶
このドキュメントもあくまで初歩であり、興味がある人は
自分自身で手を動かし、書籍やWebで公開されている情報を
蒐集することを推奨するものとします。
Sphinxのお作法
※ 細かい書式や図形の挿入などについては、以下を
参照することを推奨する。
５．indexを下ごしらえする
４で作ったフォルダ名を念頭において、index.rstを編集する。
..toctree
maxdepth
caption
/フォルダ名/ファイルその１
/フォルダ名/ファイルその２
といった要領でファイルとリンクするように記載する。
※ 上記、書式としての認識疎外のために記号等を省略している。
実際に記載するには元々の記載を優先すること。
ただし、ファイル名の指定に関して、拡張子の記載は
必要ない。
６．コンテンツファイルを作成する
４で作ったフォルダに入り、５で指定したファイル名（＋ .rst）
の形式でファイルをtouchコマンド or テキストエディタで
生成し、コンテンツの記述を行う。
ここに大きな制約は無いが、ビルドした後、ページをスクロール
しないと読み切れないほどの容量にはしない方が無難かもしれない。。
７．rstファイルからHTMLにビルドする
Sphinxのデフォルトのフォルダに移動してから、
「make html」を実行し、htmlページを生成する。
この際に、何か問題があれば赤字で表示が出るので、
何事もなくビルドできているか確認すること。
８．ブラウザから、生成したHTMLを確認する
file://home/ユーザ名/プロジェクトフォルダ/index.html
上記を確認して、書式のズレやリンク切れが無いか、精査する。
GUI 環境が必要なため、先述の文書から構築をしておくこと。
WebブラウザはChromeやFirefoxなど、ローカルファイル参照に
対応するものを準備しておく。