Sphinxドキュメント
Get started
- はじめに
- Sphinxのインストール
- Tutorial: Build your first project
User Guides
- Sphinxを使う
- reStructuredText
- Markdown
- 設定
- プロジェクト情報
- 一般的な設定
- 国際化のオプション
- Options for Math
- HTML出力のオプション
- Options for Single HTML output
- Options for HTML help output
- AppleHelp出力のオプション
- epub出力のオプション
- LaTeX出力のオプション
- テキスト出力のオプション
- manページ出力のオプション
- Texinfo出力のオプション
- Options for QtHelp output
- リンクチェックビルダーのオプション
- XML出力のオプション
- Options for the C domain
- C++ ドメインのオプション
- Options for the Python domain
- 設定ファイルの例
- Builders
StandaloneHTMLBuilderDirectoryHTMLBuilderSingleFileHTMLBuilderHTMLHelpBuilderQtHelpBuilderAppleHelpBuilderDevhelpBuilderEpub3BuilderLaTeXBuilderTextBuilderManualPageBuilderTexinfoBuilderSerializingHTMLBuilderPickleHTMLBuilderJSONHTMLBuilderMessageCatalogBuilderChangesBuilderDummyBuilderCheckExternalLinksBuilderXMLBuilderPseudoXMLBuilder- シリアライズを行うビルダーの詳細
- 拡張
- HTML Theming
- 国際化
- setuptools連係
- Sphinxウェブサポート
- Writing Sphinx Extensions
- LaTeX のカスタマイズ
- Sphinx Extensions API
コミュニティ
Reference
- Command-Line Tools
- 設定
- プロジェクト情報
- 一般的な設定
- 国際化のオプション
- Options for Math
- HTML出力のオプション
- Options for Single HTML output
- Options for HTML help output
- AppleHelp出力のオプション
- epub出力のオプション
- LaTeX出力のオプション
- テキスト出力のオプション
- manページ出力のオプション
- Texinfo出力のオプション
- Options for QtHelp output
- リンクチェックビルダーのオプション
- XML出力のオプション
- Options for the C domain
- C++ ドメインのオプション
- Options for the Python domain
- 設定ファイルの例
- 拡張
- 組み込みの拡張
sphinx.ext.autodoc-- docstringからのドキュメントの取り込みsphinx.ext.autosectionlabel-- タイトルを使用してセクションの参照ができますsphinx.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
- Sphinxを使用しているプロジェクト
- alabasterテーマを使用しているドキュメント
- クラシックテーマを使用するドキュメント
- sphinxdocテーマを使用しているドキュメント
- ネイチャーテーマを使用するドキュメント
- その他の組み込みテーマを使用しているドキュメント
- sphinx_rtd_themeを使用したドキュメント
- sphinx_bootstrap_themeを使用したドキュメント
- Documentation using pydata_sphinx_theme
- カスタムテーマを使用したドキュメント、またはWebサイトに統合されたドキュメント
- ホームページや、ドキュメント以外のサイト
- Sphinxを使って書かれた書籍
- Sphinxを用いて作製した論文
- Sphinxの機能を統合したプロジェクト