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

Docutils¶

  • https://www.python.org/dev/peps/pep-0258/

docutils では、単体のファイルを扱う

  • nodes
  • directive
    • hello
    • todo
    • sphinx.ext.graphviz
    • folium
  • roll
  • doctree
    • sphinx.addnodes.document
    • docutils.nodes.document
  • Transform
    • app.registry.transforms
    • reading

参考¶

  • https://docutils.sphinx-users.jp/docutils/docs/index.html

  • Docutils 解読ノート

  • Sphinx (Docutils) の拡張を触って得た知識とTIPS

  • 中間ファイル *.doctree の内容をみてSphinxがどのようにreSTをparseしているか知りたい

  • Inside Sphinx

  • マスタリング docutils

  • ファイルを超えてリンクを貼る (domain#resolve_xref() のすゝめ)

Next
nodes
Previous
conf.py
Copyright © 2021, ousttrue | Created using Sphinx and @pradyunsg's Furo theme. | ソースコードを表示
コンテンツ
  • Docutils
    • 参考