sphinx.config.Config

class documentation

class Config: (source)

Configuration file abstraction. The config object makes the values of all config values available as attributes. It is exposed via the :py:attr:`sphinx.application.Application.config` and :py:attr:`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	`extensions`	Undocumented
Instance Variable	`overrides`	Undocumented
Instance Variable	`setup`	Undocumented
Instance Variable	`values`	Undocumented
Instance Variable	`_raw_config`	Undocumented

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

Create a Config object from configuration file.

Parameters
confdir:`str`	Undocumented
overrides:`dict\|None`	Undocumented
tags:`Tags\|None`	Undocumented
Returns
`Config`	Undocumented

def __contains__(self, name): (source) ¶

Undocumented

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

def __delitem__(self, name): (source) ¶

Undocumented

Parameters
name:`str`	Undocumented

def __getattr__(self, name): (source) ¶

Undocumented

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

def __getitem__(self, name): (source) ¶

Undocumented

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

def __getstate__(self): (source) ¶

Obtains serializable data for pickling.

Returns
`dict`	Undocumented

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

Undocumented

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

def __iter__(self): (source) ¶

Undocumented

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

def __setitem__(self, name, value): (source) ¶

Undocumented

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

def __setstate__(self, state): (source) ¶

Undocumented

Parameters
state:`dict`	Undocumented

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

Undocumented

Parameters
name:`str`	Undocumented
default:`Any`	Undocumented
rebuild:`bool\|str`	Undocumented
types:`Any`	Undocumented

def convert_overrides(self, name, value): (source) ¶

Undocumented

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

def filter(self, rebuild): (source) ¶

Undocumented

Parameters
rebuild:`str\|list[str]`	Undocumented
Returns
`Iterator[ConfigValue]`	Undocumented

def init_values(self): (source) ¶

Undocumented

def post_init_values(self): (source) ¶

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

def pre_init_values(self): (source) ¶

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

config_values: dict[str, tuple] = (source) ¶

Undocumented

extensions: list[str] = (source) ¶

Undocumented

overrides = (source) ¶

Undocumented

setup: Callable|None = (source) ¶

Undocumented

values = (source) ¶

Undocumented

_raw_config = (source) ¶

Undocumented