Sphinxドキュメント
The Basics
- Sphinxのインストール
- Getting started
- Build your first project
User guide
- Sphinxを使う
- reStructuredText
- Markdown
- Cross-references
- 設定
- Builders
StandaloneHTMLBuilderDirectoryHTMLBuilderSingleFileHTMLBuilderHTMLHelpBuilderQtHelpBuilderAppleHelpBuilderDevhelpBuilderEpub3BuilderLaTeXBuilderTextBuilderManualPageBuilderTexinfoBuilderSerializingHTMLBuilderPickleHTMLBuilderJSONHTMLBuilderMessageCatalogBuilderChangesBuilderDummyBuilderCheckExternalLinksBuilderXMLBuilderPseudoXMLBuilder- シリアライズを行うビルダーの詳細
- Domains
- 拡張
- HTML theming
- 国際化
- Sphinxウェブサポート
- Sphinxの拡張
- Sphinx API
- LaTeX のカスタマイズ
コミュニティ
- Get support
- Contribute to Sphinx
- Sphinx FAQ
- Sphinx 作成者
Reference
- Command-line tools
- 設定
- Project tags
- プロジェクト情報
- 一般的な設定
needs_sphinxextensionsneeds_extensionsmanpages_urltodaytoday_fmt- Options for figure numbering
- Options for highlighting
- Options for HTTP requests
- Options for internationalisation
- Options for markup
- Options for Maths
- Options for the nitpicky mode
- Options for object signatures
- Options for source files
- Options for smart quotes
- Options for templating
- Options for warning control
- Builder options
- Domain options
- 拡張オプション
- Example configuration file
- 拡張
- 組み込みの拡張
sphinx.ext.apidoc-- Generate API documentation from Python packagessphinx.ext.autodoc-- docstringからのドキュメントの取り込みsphinx.ext.autosectionlabel-- Allow referencing sections by their titlesphinx.ext.autosummary-- autodocのサマリーの生成sphinx.ext.coverage-- ドキュメントのカバレッジの状況を収集しますsphinx.ext.doctest-- ドキュメント内の簡易テストsphinx.ext.duration-- Sphinx処理の処理時間を測定します。sphinx.ext.extlinks-- 外部リンクを短縮表記させるマークアップsphinx.ext.githubpages-- GitHub PagesへHTMLドキュメントを公開しますsphinx.ext.graphviz-- Graphvizのグラフを追加sphinx.ext.ifconfig-- 設定にしたがってコンテンツをON/OFFするsphinx.ext.imgconverter-- A reference image converter using Imagemagicksphinx.ext.inheritance_diagram-- 継承関係図の追加sphinx.ext.intersphinx-- 他のプロジェクトのドキュメントへのリンクsphinx.ext.linkcode-- ソースコードへの外部リンクを追加- SphinxにおけるHTML出力での数式サポート
sphinx.ext.napoleon-- NumPy および Google スタイルの docstring をドキュメントに取り込むsphinx.ext.todo-- Todoアイテムのサポートsphinx.ext.viewcode-- ハイライト済みのソースコードへのリンクを追加
- サードパーティ製の拡張機能
- 組み込みの拡張
- reStructuredText
- 用語集
- Changelog
- Release 9.1.0 (released Dec 31, 2025)
- Prior releases
- Sphinx 9.0
- Sphinx 8.2
- Sphinx 8.1
- Sphinx 8.0
- Sphinx 7.4
- Sphinx 7.3
- Sphinx 7.2
- Sphinx 7.1
- Sphinx 7.0
- Sphinx 6.2
- Sphinx 6.1
- Sphinx 6.0
- Sphinx 5.3
- Sphinx 5.2
- Sphinx 5.1
- Sphinx 5.0
- Sphinx 4.5
- Sphinx 4.4
- Sphinx 4.3
- Sphinx 4.2
- Sphinx 4.1
- Sphinx 4.0
- Sphinx 3.5
- Sphinx 3.4
- Sphinx 3.3
- Sphinx 3.2
- Sphinx 3.1
- Sphinx 3.0
- Sphinx 2.4
- Sphinx 2.3
- Sphinx 2.2
- Sphinx 2.1
- Sphinx 2.0
- Sphinx 1.8
- Sphinx 1.7
- Sphinx 1.6
- Sphinx 1.5
- Sphinx 1.4
- Sphinx 1.3
- Sphinx 1.2
- Sphinx 1.1
- Sphinx 1.0
- Sphinx 0.6
- Sphinx 0.5
- Sphinx 0.4
- Sphinx 0.3
- Sphinx 0.2
- Sphinx 0.1
- Sphinxを使用しているプロジェクト
- alabasterテーマを使用しているドキュメント
- クラシックテーマを使用するドキュメント
- sphinxdocテーマを使用しているドキュメント
- ネイチャーテーマを使用するドキュメント
- その他の組み込みテーマを使用しているドキュメント
- Documentation using Read the Docs Sphinx Theme
- Documentation using Sphinx Bootstrap Theme
- Documentation using PyData Sphinx Theme
- Documentation using Furo theme
- カスタムテーマを使用したドキュメント、またはWebサイトに統合されたドキュメント
- ホームページや、ドキュメント以外のサイト
- Sphinxを使って書かれた書籍
- Sphinxを用いて作製した論文
- Sphinxの機能を統合したプロジェクト