Sphinx試し中メモ

ドキュメントビルドツールのSphinxを使ってみました。

• Overview — Sphinx 2.1.0+/12c614911 documentation

Sphinxドキュメント日本語訳と、翻訳された渋川さんのチュートリアル（記事中にリンク有り）のおかげで、基本的な操作はできるようになりました。

でも、toctreeが、まだよく分かっていません。どうやらここが大事らしい。自分が今まで使ってきたツールにはない概念です。もうちょっと使ってみようっと。

チュートリアル中につまったところ

• 「make html」がきかない。
  • sourceフォルダとbuild先フォルダを分けたり、build/htmlフォルダを作ってもダメ。
  • パスの問題？？
  • 今は「sphinx-build -d html (sourceディレクトリ) (build先ディレクトリ)」でやってる。
• 数字付きリストは「#.（記号＋ピリオド）」。「#」だけじゃダメ。
• ビルド時に、各文書のタイトルを拾ってくれる。タイトルがない文書が含まれているとWARNINGが出る。
• 構文の前後には、半角スペースを空ける。文中の場合は、「\」＋「半角スペース」にする。
• リンクの表記で使う記号は、シングルクォーテーション（'）ではなく、グラーブアクセント（`）。