仕様・利用条件は変わることがあります。重要な判断は原典と実際の結果で再確認してください。
この手段について
- 目的
- Sphinxで検証用の文書をHTMLへbuildする
- 構成
- Sphinx + Python
最短の利用経路
- 対応Pythonと検証用source directoryを用意する
- quickstartで構成し小さな文書を記述する
- HTMLをbuildして参照と表示を確認する
必要条件
- 対応OSまたは許可された利用環境
- 共有してよい入力・保存先と出力形式を確認する
- 公式の利用開始案内でSphinxの対応環境・導入方法・利用条件を確認し、検証用の環境へ用意します。
向く場面
Sphinxで検証用の文書をHTMLへbuildするという一つの目的を、この利用経路で短く試したい場面。
向かない場面
警告を確認せず文書の参照がすべて有効だとする用途。
確認方法
build警告・見出し・相互参照と生成したHTMLを照合します。