BuildPhase

• https://www.sphinx-doc.org/ja/master/extdev/index.html#build-phases

• https://www.sphinx-doc.org/ja/master/extdev/appapi.html#events

from enum import IntEnum


class BuildPhase(IntEnum):
    """Build phase of Sphinx application."""
    INITIALIZATION = 1
    READING = 2
    CONSISTENCY_CHECK = 3
    RESOLVING = 3
    WRITING = 4

• INITIALIZATION
  • sphinx.application.Sphinx
  • extension の import と setup
  • sphinx.application.Sphinx._init_env
    • sphinx.application.Sphinx._init_builder

Reading

• READING
  • sphinx.util.i18n.CatalogRepository
  • prepare
    • conf.py の更新チェック
    • template の更新チェック
    • env の更新チェック
  • event
  • foreach docname
    • if doc changed and not removed
    • run source parsers: text -> docutils.document
    • apply transforms based on priority: docutils.document -> docutils.document
  • merge(if running in parallel mode, this event will be emitted for each process)
  • updated
  • 中間ファイル
    • Environment
    • .doctree

Check, Resolve, Writing

• CONSISTENCY_CHECK
  • document isn't included in any toctree
• RESOLVING
  • prepare_writing
• WRITING
  • write