Sphinx（ドキュメント生成ツール）

Sphinxは、Pythonコミュニティによって開発・使用されているドキュメント生成ツールです。Pythonで記述されていますが、他の環境でも使用されています。

Sphinx はreStructuredTextファイルをHTMLウェブサイトやPDF、EPub、Texinfo、manなどの他の形式に変換します。

reStructuredTextは拡張可能であり、Sphinxはその拡張性を活用し、ソースコードからのドキュメントの自動生成、数式表記の記述、ソースコードのハイライト表示など、さまざまな拡張機能を提供しています。

MyST Parserなどの拡張機能のおかげで、Markdownファイルも使用できるようになりました。 ^{[ 3 ]}

最初の公開版であるバージョン0.1.61611は、2008年3月21日に発表されました。^{[ 10 ]}これは、 Pythonプロジェクトのドキュメント作成のために開発され、広く使用されています。^{[ 11 ]}

2008年に導入されて以来、SphinxはBazaar、SQLAlchemy、MayaVi、SageMath、SciPy、Django、Pylonsなど、他の多くの重要なPythonプロジェクトに採用されています。Blenderのユーザーマニュアル^{[ 12 ]}やPython APIドキュメント^{[ 13 ]}にも使用されています。

2010年、Eric Holscherは^{[ 14 ]}ソフトウェアドキュメントのメンテナンスを容易にするための取り組みの一環としてRead the Docsプロジェクトの作成を発表しました。Read the DocsはコミットごとにSphinxドキュメントをビルドしてアップロードするプロセスを自動化します。

• ドキュメント生成ツールの比較
• ドキュメントをお読みください
• 再構成テキスト

• 公式サイト
• Read the Docsは、Sphinxを基盤とした大規模な共同ドキュメントホストです。