Sphinxドキュメント

Get started

• はじめに
  • ドキュメントのソースの準備
  • ドキュメント構造の定義
  • コンテンツの追加
  • ビルドの実行
  • オブジェクトのドキュメントを書く
    • enumerate()
  • 基本設定
  • Autodoc
  • Intersphinx
  • さらに説明すべきトピック
• Sphinxのインストール
  • 概要
  • Linux
    • Debian/Ubuntu
    • RHEL, CentOS
    • 他のディストリビューション
  • macOS
    • Homebrew
    • MacPorts
    • Anaconda
  • Windows
    • Chocolatey
    • Other Methods
  • PyPIからインストール
    • Using virtual environments
  • Docker
  • ソースからインストール
• Tutorial: Build your first project
  • Getting started
    • Setting up your project and development environment
    • Creating the documentation layout
  • First steps to document your project using Sphinx
    • Building your HTML documentation
    • Building your documentation in other formats
  • More Sphinx customization
    • Enabling a built-in extension
    • Using a third-party HTML theme
  • Sphinx におけるナラティブドキュメンテーション
    • 複数のページにまたがるドキュメンテーションを構造化することについて
    • クロスリファレンスを追加することについて
  • Describing code in Sphinx
    • Python
    • Other languages (C, C++, others)
  • Automatic documentation generation from code
    • Reusing signatures and docstrings with autodoc
    • Generating comprehensive API references
  • Appendix: Deploying a Sphinx project online
    • Sphinx-friendly deployment options
    • Embracing the "Docs as Code" philosophy
    • Publishing your documentation sources
    • Publishing your HTML documentation
  • Where to go from here

User Guides

• Sphinxを使う
  • reStructuredText
    • reStructuredText入門
    • ロール
    • ディレクティブ
    • Field Lists
    • Domains
  • 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
    • StandaloneHTMLBuilder
    • DirectoryHTMLBuilder
    • SingleFileHTMLBuilder
    • HTMLHelpBuilder
    • QtHelpBuilder
    • AppleHelpBuilder
    • DevhelpBuilder
    • Epub3Builder
    • LaTeXBuilder
    • TextBuilder
    • ManualPageBuilder
    • TexinfoBuilder
    • SerializingHTMLBuilder
    • PickleHTMLBuilder
    • JSONHTMLBuilder
    • MessageCatalogBuilder
    • ChangesBuilder
    • DummyBuilder
    • CheckExternalLinksBuilder
    • XMLBuilder
    • PseudoXMLBuilder
    • シリアライズを行うビルダーの詳細
  • 拡張
    • 組み込みの拡張
    • サードパーティ製の拡張機能
  • HTML Theming
    • Builders
    • Themes
  • 国際化
    • Sphinx 国際化について
    • sphinx-intlを使っての翻訳
    • チームでの翻訳に Transifex サービスを利用する
    • Sphinxリファレンスの翻訳に貢献する
  • setuptools連係
    • setuptools連係の使用
    • setuptools連係のオプション
  • Sphinxウェブサポート
    • Webサポートクイックスタート
    • WebSupportクラス
    • 検索アダプタ
    • ストレージバックエンド
• Sphinxの拡張
  • 拡張機能の開発の概要
    • 他の拡張機能に依存する拡張の作成
  • 拡張機能のチュートリアル
    • "Hello world" 拡張機能の開発
    • "TODO" 拡張機能の開発
    • "recipe" 拡張機能の開発
    • Developing autodoc extension for IntEnum
  • ビルダーの設定
    • エントリーポイント別ビルダー紹介
  • HTML theme development
    • テーマを作成する
    • Distribute your theme as a Python package
    • テンプレート
• テンプレート
  • HTMLを生成するのにSphinxのテンプレートを使用する必要があるのか？
  • Jinja/Sphinxテンプレートの基礎
  • 組み込みテンプレートの働き
    • ブロック
    • 設定値
    • ヘルパー関数
    • グローバル変数
• LaTeX のカスタマイズ
  • The latex_elements configuration setting
  • The sphinxsetup configuration setting
  • Additional CSS-like 'sphinxsetup' keys
  • LaTeX macros and environments
    • マクロ
    • Environments
    • Miscellany
• Sphinx拡張機能の開発
  • 重要なオブジェクト
  • ビルド・フェーズ
  • 拡張機能のメタデータ
  • 拡張機能を書く際に利用するAPI
    • アプリケーションAPI
    • プロジェクト API
    • ビルド環境API
    • Builder API
    • Environment Collector API
    • Docutils マークアップ API
    • ドメインAPI
    • パーサAPI
    • Sphinxが追加したDoctreeのノードクラス
    • Logging API
    • i18n API
    • ユーティリティ
    • 非推奨 API

コミュニティ

• Get support
• Contribute to Sphinx
  • Sphinx への貢献
    • Get help
    • バグ報告と機能のリクエスト
    • Contribute code
    • Contribute documentation
    • Debugging tips
  • Sphinx's release process
    • Versioning
    • 非推奨の機能
    • 非推奨についての方針
    • Python version support policy
    • Release procedures
  • Organization of the Sphinx project
    • Core developers
    • Other contributors
  • Sphinx行動規範
  • Sphinx 作成者
    • Maintainers
    • Contributors
    • Included software
• Sphinx FAQ
  • どのようにすれば...
  • Sphinxと一緒に ... を使うには？
  • Sphinx 対 Docutils
  • Epub情報
  • Texinfo情報
    • リンクの表示
    • メモ

Reference

• Command-Line Tools
  • 主要アプリケーション
    • sphinx-quickstart
    • sphinx-build
  • 追加アプリケーション
    • sphinx-apidoc
    • sphinx-autogen
• 用語集
• Changelog
• Sphinxを使用しているプロジェクト
  • alabasterテーマを使用しているドキュメント
  • クラシックテーマを使用するドキュメント
  • sphinxdocテーマを使用しているドキュメント
  • ネイチャーテーマを使用するドキュメント
  • その他の組み込みテーマを使用しているドキュメント
  • sphinx_rtd_themeを使用したドキュメント
  • sphinx_bootstrap_themeを使用したドキュメント
  • カスタムテーマを使用したドキュメント、またはWebサイトに統合されたドキュメント
  • ホームページや、ドキュメント以外のサイト
  • Sphinxを使って書かれた書籍
  • Sphinxを用いて作製した論文
  • Sphinxの機能を統合したプロジェクト