Sphinxとは？¶
SphinxはPytho製のドキュメント生成ツールです。
- ドキュメント内の検索機能
- テキストベースなのでGitなどで履歴管理が可能
- 記述言語は
reStructuredTextだがCommonMarkdownも使用可能 HTML以外にもePub、PDFなど様々な出力形式LaTeXを使用した数式も記述可能- Jupyter Notebook も取り込み可能
- Font Awesome 使用可能
- オートビルド可
LaTexによる数式¶
\[\frac{3 \pi}{2} + \frac{e{i x}}{x{2} + y}
\]
数式を\(\frac{1}{2} \frac{\partial j}{\partial p_2}\)のようにインラインで記述可能。
GitHubPage対応¶
このようにGitHubPageにも簡単に対応可能です。
PDFで出力¶
$ make latexpdfja