仕様・利用条件は変わることがあります。重要な判断は原典と実際の結果で再確認してください。
基本情報
- 種別
- 文書生成ツール
- どこから使うか
- Python · CLI · reStructuredText
使い始める
公式の利用開始案内でSphinxの対応環境・導入方法・利用条件を確認し、検証用の環境へ用意します。
主な能力
- 文書構成
- 相互参照
- HTML生成
必要条件
- 対応OSまたは許可された利用環境
- 共有してよい入力・保存先と出力形式を確認する
向く場面
Sphinxで検証用の文書をHTMLへbuildするなど、文書構成の利用経路を選びたい場面。
向かない場面
警告を確認せず文書の参照がすべて有効だとする用途。