sphinx-doc/sphinx

これは何？

主な機能

• 01HTML、PDF、プレーンテキスト、EPUB、TeX、manページに出力
• 02関数、クラス、用語集の項目を意味的に相互参照
• 03関連ページ間のリンクを自動生成するドキュメントツリーを構築
• 04一般索引とモジュール索引を自動生成
• 05Pygmentsでコードをハイライトし、Jinja 2テンプレートでHTMLを生成
• 06拡張機能のエコシステムを通じて機能を追加でき、Python、C、C++、JavaScriptの言語サポートにも対応

ユースケース

• PythonライブラリのAPIリファレンスを公開する
• ひとつのソースからPDFとHTMLを生成する技術マニュアルを作成する
• 相互参照を使って、多言語版またはバージョン管理されたプロジェクトドキュメントを保守する

クイックスタート

1. 1

   pip を使って PyPI から Sphinx をインストールします

   pip install -U sphinx

使う前に知っておきたいこと

• !README には明確なライセンス名が記載されていません。メタデータでは NOASSERTION とされていますが、バッジには BSD 2-Clause と表示されています。

トピック

よくある質問

sphinx とは？

reStructuredTextやMarkdownのソースから、HTML、PDF、EPUBなどを生成するPython製ドキュメントジェネレーター。 Sphinxは、reStructuredTextのソースファイルから体裁の整ったドキュメントを生成するドキュメントジェネレーターです。HTML、PDF、プレーンテキスト、EPUB、TeX、manページなどに出力でき、解析と変換にはDocutilsを使用しています。

sphinx は無料で使えますか？ライセンスは？

sphinx は Other ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。

sphinx は今もメンテナンスされていますか？

活発にメンテナンス中。sphinx の最終コミットは 2026年10月22日 です。

sphinx は何に使えますか？

PythonライブラリのAPIリファレンスを公開する ひとつのソースからPDFとHTMLを生成する技術マニュアルを作成する 相互参照を使って、多言語版またはバージョン管理されたプロジェクトドキュメントを保守する

sphinx のインストール方法は？

pip を使って PyPI から Sphinx をインストールします: pip install -U sphinx

sphinx はどこで入手できますか？

ソースコードとインストール手順は GitHub にあります：https://github.com/sphinx-doc/sphinx