Sphinx (ドキュメンテーションジェネレータ)とは？わかりやすく解説

Sphinx
作者	Georg Brandl
初版	2008年3月21日 (16年前)
最新版	8.1.3 / 2024年10月14日 (4か月前)
リポジトリ	github.com/sphinx-doc/sphinx;
プログラミング; 言語	Python
対応OS	クロスプラットフォーム
種別	ドキュメンテーションジェネレータ
ライセンス	修正BSDライセンス
公式サイト	www.sphinx-doc.org
	テンプレートを表示

Sphinxは、Pythonで書かれているドキュメンテーションジェネレータである。主にPythonコミュニティで利用されているが、その他の環境でも利用されている。

目的と機能

SphinxはreStructuredTextをHTML (ウェブサイト) やPDF、EPUB、Texinfo及びmanページなどの他のフォーマットに変換する。

reStructuredTextには拡張性があり、Sphinxはソースコードからのドキュメントの自動生成、数式の表現、ソースコードのシンタックスハイライトなどにこれを利用している。

歴史と用例

最初の公開リリースであるバージョン 0.1.61611は000000002008-03-21-00002008年3月21日に発表された^[2]。 SphinxはPythonプロジェクトのドキュメントのために開発され、広く利用されている^[3]。

Sphinxは000000002008-01-01-00002008年に公開されて以来、Bazaar、SQLAlchemy、MayaVi、SageMath、SciPy、Django、Pylonsなどの他の多くの重要なPythonプロジェクトで採用されている。また、Blenderのユーザーマニュアル^[4]やPythonのAPIドキュメント^[5]にも採用されている。

000000002010-01-01-00002010年、Eric Holscherはソフトウェアドキュメントの保守を容易にするための取り組みの一環として、Read the Docs（英語版）プロジェクトを発表した^[6]。 Read the Docsは、各コミット時にSphinxドキュメントの生成とアップロードを自動的に行う。

Linuxカーネル

Linuxカーネルのドキュメントサブシステムは000000002016-01-01-00002016年に変更された。バージョン 4.7以降では、ドキュメントはSphinxを使用するように変更されている^[7]。

LCA2016: What I've learned as the kernel docs maintainer - YouTube
LCA2017: Kernel documentation: what we have and where it's going - YouTube

脚注

^ “Releases”. GitHub. 2025年2月8日閲覧。
^ “Sphinx is released! » And now for something completely Pythonic...”. And now for something completely Pythonic.... Georg Brandl. 2012年3月22日時点のオリジナルよりアーカイブ。2011年4月3日閲覧。
^ “About these documents — Python v2.7.1 documentation”. Python documentation. Python Software Foundation. 2011年4月3日閲覧。
^ “Blender User Manual”. Blender Wiki. Blender Foundation. 2020年5月24日閲覧。
^ “Dev:2.5/Py/API/Generating API Reference - BlenderWiki!”. Blender Foundation. Blender Foundation. 2020年5月24日閲覧。
^ “Announcing Read The Docs”. Python Software Foundation News. Eric Holscher. 2015年2月15日閲覧。
^ “Kernel documentation update”. LWN.net (2016年11月2日). 2020年5月24日閲覧。

外部リンク

[1] “Releases”. GitHub. 2025年2月8日閲覧。

[2] “Sphinx is released! » And now for something completely Pythonic...”. And now for something completely Pythonic.... Georg Brandl. 2012年3月22日時点のオリジナルよりアーカイブ。2011年4月3日閲覧。

[3] “About these documents — Python v2.7.1 documentation”. Python documentation. Python Software Foundation. 2011年4月3日閲覧。

[4] “Blender User Manual”. Blender Wiki. Blender Foundation. 2020年5月24日閲覧。

[5] “Dev:2.5/Py/API/Generating API Reference - BlenderWiki!”. Blender Foundation. Blender Foundation. 2020年5月24日閲覧。

[6] “Announcing Read The Docs”. Python Software Foundation News. Eric Holscher. 2015年2月15日閲覧。

[7] “Kernel documentation update”. LWN.net (2016年11月2日). 2020年5月24日閲覧。

[1]

[2]

[3]

[4]

[5]

[6]

[7]

Sphinx (ドキュメンテーションジェネレータ)とは？ わかりやすく解説