SPHINX

概要

• 概要 — Sphinx 4.0.0+/208cb8ab8 ドキュメント
• ドキュメントを作成するツール。
• 多くのドキュメント作成で利用されており、例えばPythonの公式ドキュメントもそのひとつ。
  • Sphinxを使用しているプロジェクト — Sphinx 4.0.0+/208cb8ab8 ドキュメント

記法

• reStructuredTextで記述する。
  • reStructuredText

Jupyter Notebook との連携

• SPHINXの拡張パッケージに「nbsphinx」がある。
• これを利用することで、Jupyter Notebook をドキュメントのソースとして利用することができる。
• GitHub - spatialaudio/nbsphinx: Sphinx source parser for Jupyter notebooks
• nbsphinx の紹介 - Qiita

Githubとの連携

• GithubはJupyter Notebookをサポートしていることから、Github→Jupyter→SPHINXの連携が多くみられる。

SPHINXの学習教材

• sphinx handson — study sphinx 1 documentation
• GitHub - planset/study_sphinx: 2013/12/21 Sphinx勉強会用資料