Sphinx (ドキュメンテーションジェネレータ)
 | この項目「Sphinx (ドキュメンテーションジェネレータ)」は翻訳されたばかりのものです。不自然あるいは曖昧な表現などが含まれる可能性があり、このままでは読みづらいかもしれません。（原文：英語版 "Sphinx (documentation generator)" 2019年9月3日 (火) 16:07 (UTC)） 修正、加筆に協力し、現在の表現をより自然な表現にして下さる方を求めています。ノートページや履歴も参照してください。（2020年5月） |
| 作者 | Georg Brandl |
|---|---|
| 初版 | 2008年3月21日 |
| 最新版 |
7.3.7
/ 2024年4月19日[1] |
| リポジトリ | |
| プログラミング 言語 | Python |
| 対応OS | クロスプラットフォーム |
| 種別 | ドキュメンテーションジェネレータ |
| ライセンス | 修正BSDライセンス |
| 公式サイト |
www |
Sphinxは、Pythonで書かれているドキュメンテーションジェネレータである。 主にPythonコミュニティで利用されているが、その他の環境でも利用されている。
目的と機能
[編集]SphinxはreStructuredTextをHTML (ウェブサイト) やPDF、EPUB、Texinfo及びmanページなどの他のフォーマットに変換する。
reStructuredTextには拡張性があり、Sphinxはソースコードからのドキュメントの自動生成、数式の表現、ソースコードのシンタックスハイライトなどにこれを利用している。
歴史と用例
[編集]最初の公開リリースであるバージョン 0.1.61611は2008年3月21日に発表された[2]。 SphinxはPythonプロジェクトのドキュメントのために開発され、広く利用されている[3]。
Sphinxは2008年に公開されて以来、Bazaar、SQLAlchemy、MayaVi、SageMath、SciPy、Django、Pylonsなどの他の多くの重要なPythonプロジェクトで採用されている。 また、Blenderのユーザーマニュアル[4]やPythonのAPIドキュメント[5]にも採用されている。
2010年、Eric Holscherはソフトウェアドキュメントの保守を容易にするための取り組みの一環として、Read the Docsプロジェクトを発表した[6]。 Read the Docsは、各コミット時にSphinxドキュメントの生成とアップロードを自動的に行う。
Linuxカーネル
[編集]Linuxカーネルのドキュメントサブシステムは2016年に変更された。 バージョン 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. 2024年4月19日閲覧。
- ^ “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日閲覧。