sphinx.environment

package documentation
(source)

Global creation environment.

Package adapters Sphinx environment adapters
Package collectors The data collector components for sphinx.environment.

From __init__.py:

Class BuildEnvironment The environment in which the ReST files are translated. Stores an inventory of cross-file targets and provides doctree transformations to resolve links to them.
Constant CONFIG_CHANGED Undocumented
Constant CONFIG_CHANGED_REASON Undocumented
Constant CONFIG_EXTENSIONS_CHANGED Undocumented
Constant CONFIG_NEW Undocumented
Constant CONFIG_OK Undocumented
Constant ENV_VERSION Undocumented
Variable default_settings Undocumented
Variable logger Undocumented
Variable versioning_conditions Undocumented
Class _DomainsType Undocumented
logger = (source)

Undocumented

default_settings: dict[str, Any] = (source)

Undocumented

ENV_VERSION: int = (source)

Undocumented

Value
57
CONFIG_OK: int = (source)

Undocumented

Value
1
CONFIG_NEW: int = (source)

Undocumented

Value
2
CONFIG_CHANGED: int = (source)

Undocumented

Value
3
CONFIG_EXTENSIONS_CHANGED: int = (source)

Undocumented

Value
4
CONFIG_CHANGED_REASON = (source)

Undocumented

Value
{CONFIG_NEW: __('new config'),
 CONFIG_CHANGED: __('config changed'),
 CONFIG_EXTENSIONS_CHANGED: __('extensions changed')}
versioning_conditions: dict[str, bool|Callable] = (source)

Undocumented