Contents Menu Expand Light mode Dark mode Auto light/dark mode
read sphinx ドキュメント
read sphinx ドキュメント
  • デバッグ
  • BuildPhase
    • INITIALIZATION
    • READING
    • CONSISTENCY_CHECK
    • RESOLVING
    • WRITING
  • conf.py
  • Docutils
    • nodes
    • directive
    • roll
    • doctree
    • Transform
  • Environment
    • 初期化
    • sphinx.project.Project
    • domaindata
    • EnvironmentCollector
  • Builder
    • HTMLBuilder
  • Theme
    • basicテーマ
    • furo
    • customize
    • テーマの作成
  • Extension
    • 組み込み拡張
      • autodoc
      • graphviz
      • inheritance_diagram
    • 外部拡張
      • myst_parser
      • blockdiag
      • ablog
      • nbsphinx
    • 拡張の作り方
      • Directive
  • Command
    • sphinx-autobuild
  • Internationalization(i18n)
    • workflow
    • build
  • Language Server

Extension¶

sphinx 拡張は、 setup 関数をもつ python モジュール。

  • (6日目) Sphinx 拡張の紹介

  • 組み込み拡張
    • autodoc
      • 設定
      • docstring
      • docstring の style
    • graphviz
      • dot 言語
    • inheritance_diagram
      • apidoc と連携する例
  • 外部拡張
    • myst_parser
      • MystParser
        • docutils.readers.Reader
        • myst_parser.sphinx_parser.MystParser
          • markdown-it-py parser
        • myst_parser.sphinx_renderer.SphinxRenderer
    • blockdiag
    • ablog
    • nbsphinx
      • jupyter の参考
      • 実行例
  • 拡張の作り方
    • setup
      • Directive
Next
組み込み拡張
Previous
テーマの作成
Copyright © 2021, ousttrue | Created using Sphinx and @pradyunsg's Furo theme. | ソースコードを表示