Class _CurrentDocument

sphinx/environment/__init__.py:963–1187

Temporary data storage while reading a document. This class is only for internal use. Please don't use this in your extensions. It will be removed or changed without notice. The only stable API is via ``env.current_document``.

class _CurrentDocument:
    """Temporary data storage while reading a document.

    This class is only for internal use. Please don't use this in your extensions.
    It will be removed or changed without notice.
    The only stable API is via ``env.current_document``.
    """

    __slots__ = (
        '_parser',
        '_serial_numbers',
        '_extension_data',
        'autodoc_annotations',
        'autodoc_class',
        'autodoc_module',
        'c_last_symbol',
        'c_namespace_stack',
        'c_parent_symbol',
        'cpp_domain_name',
        'cpp_last_symbol',
        'cpp_namespace_stack',
        'cpp_parent_symbol',
        'default_domain',
        'default_role',
        'docname',
        'highlight_language',
        'obj_desc_name',
        'reading_started_at',
    )

    # Map of old-style temp_data keys to _CurrentDocument attributes
    __attr_map: Final = {
        '_parser': '_parser',
        'annotations': 'autodoc_annotations',
        'autodoc:class': 'autodoc_class',
        'autodoc:module': 'autodoc_module',
        'c:last_symbol': 'c_last_symbol',
        'c:namespace_stack': 'c_namespace_stack',
        'c:parent_symbol': 'c_parent_symbol',
        'cpp:domain_name': 'cpp_domain_name',
        'cpp:last_symbol': 'cpp_last_symbol',
        'cpp:namespace_stack': 'cpp_namespace_stack',
        'cpp:parent_symbol': 'cpp_parent_symbol',
        'default_domain': 'default_domain',
        'default_role': 'default_role',
        'docname': 'docname',
        'highlight_language': 'highlight_language',
        'object': 'obj_desc_name',
        'started_at': 'reading_started_at',
    }

    # Attributes that should reset to None if popped.
    __attr_default_none: Final = frozenset({
        '_parser',
        'c:last_symbol',
        'c:parent_symbol',
        'cpp:last_symbol',
        'cpp:parent_symbol',