The Basics
User guide
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.ext.napoleon -- NumPy および Google スタイルの docstring をドキュメントに取り込むsphinx.ext.todo -- Todoアイテムのサポートsphinx.ext.viewcode -- ハイライト済みのソースコードへのリンクを追加コミュニティ
Reference
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.ext.napoleon -- NumPy および Google スタイルの docstring をドキュメントに取り込むsphinx.ext.todo -- Todoアイテムのサポートsphinx.ext.viewcode -- ハイライト済みのソースコードへのリンクを追加sphinx.ext.githubpages -- GitHub PagesへHTMLドキュメントを公開します¶Added in version 1.4.
バージョン 2.0 で変更: CNAME ファイルをサポート
この拡張はGitHub Pagesで公開するために、 .nojekyll ファイルをHTMLディレクトリ内に作成します。
また、 html_baseurl セットの場合、カスタムドメイン用の CNAME ファイルを作成します。