概要
Sphinxは、reStructuredTextを中心に文書の階層、相互参照、索引、コード表示を組み立て、HTML、PDF、EPUB、man pageなどへ出力するPython製ドキュメントジェネレーターです。拡張機能とthemeでAPI文書や大型manualへ展開できます。
特徴と向いている用途
公式資料に基づく紹介・実機未検証 · 内容確認日:
相互参照を保ったままHTMLからPDFまで生成する
公式READMEは、出力形式としてHTML、LaTeX経由のPDF、ePub、Texinfo、manual page、plain textを挙げます。意味的markupと自動link、文書階層、索引、code handling、extension API、Pygmentsによるhighlight、Jinja2 templateを組み合わせられます。
出典:[1]
API referenceと長く育つ技術文書を同じsourceで管理したい場合
Python projectのAPI文書、libraryや製品のmanual、複数章にまたがる設計文書など、参照関係と構造を保ちながら複数媒体へ公開したい用途に適します。extensionとthemeを選ぶことで、組織固有の記法や見た目も組み込めます。
出典:[1]
記法、theme、extension、versionの組み合わせを固定する
導入時はPython環境とpip、reStructuredTextの記法、builderごとの出力差を理解する必要があります。Sphinx本体・theme・extensionのversion互換性を固定し、warningをCIで確認してください。公式LICENSE.rstはBSD 2-Clauseの条件を示します。
参考にした公式資料
- [1]Sphinx README(2026-09-13)
- [2]Sphinx LICENSE(2026-09-13)
編集部からの補足
神話上の名称との衝突を、documentation generator・reStructuredText・Pythonの専門語と公式文書ecosystemで解消する例として選びました。
成長
成長の推移 · 直近30日
8,010 Stars
推移データを蓄積中です。
開発アクティビティ
直近90日・週次
- Commit(直近30日)
- 0
- Open PR
- 243
開発アクティビティを蓄積中です。
Built with
カテゴリとタグ
GitHubデータ
GitHubのデータGitHubの詳細データを見る
GitHub Topics
- python
- documentation
- documentation-tool
- sphinx
- markdown
- restructuredtext
- docs
- Stars
- 8,010
- Forks
- 2,559
- Watchers
- 176
- Open Issues
- 1,193
- 主要言語
- Python
- ライセンス
- 未判定
- リポジトリ最終更新
- 2026/09/07
あわせて探訪
- React250,401 Stars
宣言的なコンポーネントでWebとネイティブのUIを構築するJavaScriptライブラリ。
JavaScript - Visual Studio Code(Code - OSS)192,456 Stars
Visual Studio Codeの基盤となるMITライセンスのCode - OSSリポジトリ。
TypeScript - Flutter178,927 Stars
一つのDartコードベースからモバイル・Web・デスクトップへ展開するGoogleのクロスプラットフォームUI SDK。
Dart - Bootstrap174,778 Stars
responsive・mobile-firstなWeb UIをCSS、JavaScript、grid、utility、componentから構築するframework。
MDX - LangChain146,226 Stars
モデル・ツール・検索基盤などを共通インターフェースでつなぐ、LLMアプリとエージェント向けPythonフレームワーク。
Python
情報の誤りを報告
掲載内容に誤りや古い情報があればお知らせください。