sphinx.environment

package documentation

Global creation environment.

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.
Package collectors sphinx.environment.collectors ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Package adapters sphinx.environment.adapters ~~~~~~~~~~~~~~~~~~~~~~~~~~~

From __init__.py:

Class ​Build​Environment 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
logger =

Undocumented

default_settings: Dict[str, Any] =

Undocumented

ENV_VERSION: int =

Undocumented

Value
56
CONFIG_OK: int =

Undocumented

Value
1
CONFIG_NEW: int =

Undocumented

Value
2
CONFIG_CHANGED: int =

Undocumented

Value
3
CONFIG_EXTENSIONS_CHANGED: int =

Undocumented

Value
4
CONFIG_CHANGED_REASON =

Undocumented

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

Undocumented