sphinx.config.Config

class documentation

class Config:

Configuration file abstraction.

The config object makes the values of all config values available as attributes.

It is exposed via the sphinx.application.Application.config and sphinx.environment.Environment.config attributes. For example, to get the value of :confval:`language`, use either app.config.language or env.config.language.

Class Method	`read`	Create a Config object from configuration file.
Method	`__contains__`	Undocumented
Method	`__delitem__`	Undocumented
Method	`__getattr__`	Undocumented
Method	`__getitem__`	Undocumented
Method	`__getstate__`	Obtains serializable data for pickling.
Method	`__init__`	Undocumented
Method	`__iter__`	Undocumented
Method	`__setitem__`	Undocumented
Method	`__setstate__`	Undocumented
Method	`add`	Undocumented
Method	`convert_overrides`	Undocumented
Method	`filter`	Undocumented
Method	`init_values`	Undocumented
Method	`post_init_values`	Initialize additional config variables that are added after init_values() called.
Method	`pre_init_values`	Initialize some limited config variables before initializing i18n and loading extensions.
Class Variable	`config_values`	Undocumented
Instance Variable	`_raw_config`	Undocumented
Instance Variable	`extensions`	Undocumented
Instance Variable	`overrides`	Undocumented
Instance Variable	`setup`	Undocumented
Instance Variable	`values`	Undocumented

@classmethod
def read(cls, confdir, overrides=None, tags=None):

Create a Config object from configuration file.

Parameters
confdir:`str`	Undocumented
overrides:`Dict`	Undocumented
tags:`Tags`	Undocumented
Returns
`Config`	Undocumented

def __contains__(self, name):

Undocumented

Parameters
name:`str`	Undocumented
Returns
`bool`	Undocumented

def __delitem__(self, name):

Undocumented

Parameters
name:`str`	Undocumented

def __getattr__(self, name):

Undocumented

Parameters
name:`str`	Undocumented
Returns
`Any`	Undocumented

def __getitem__(self, name):

Undocumented

Parameters
name:`str`	Undocumented
Returns
`Any`	Undocumented

def __getstate__(self):

Obtains serializable data for pickling.

Returns
`Dict`	Undocumented

def __init__(self, config={}, overrides={}):

Undocumented

Parameters
config:`Dict[str, Any]`	Undocumented
overrides:`Dict[str, Any]`	Undocumented

def __iter__(self):

Undocumented

Returns
`Generator[ConfigValue, None, None]`	Undocumented

def __setitem__(self, name, value):

Undocumented

Parameters
name:`str`	Undocumented
value:`Any`	Undocumented

def __setstate__(self, state):

Undocumented

Parameters
state:`Dict`	Undocumented

def add(self, name, default, rebuild, types):

Undocumented

Parameters
name:`str`	Undocumented
default:`Any`	Undocumented
rebuild:`Union[bool, str]`	Undocumented
types:`Any`	Undocumented

def convert_overrides(self, name, value):

Undocumented

Parameters
name:`str`	Undocumented
value:`Any`	Undocumented
Returns
`Any`	Undocumented

def filter(self, rebuild):

Undocumented

Parameters
rebuild:`Union[str, List[str]]`	Undocumented
Returns
`Iterator[ConfigValue]`	Undocumented

def init_values(self):

Undocumented

def post_init_values(self):

Initialize additional config variables that are added after init_values() called.

def pre_init_values(self):

Initialize some limited config variables before initializing i18n and loading extensions.

config_values: Dict[str, Tuple] =

Undocumented

_raw_config =

Undocumented

extensions: List[str] =

Undocumented

overrides =

Undocumented

setup: Optional[Callable] =

Undocumented

values =

Undocumented