sphinx.config

module documentation

Build configuration file handling.

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.

Class	`Config`	Configuration file abstraction.
Constant	`CONFIG_FILENAME`	Undocumented
Constant	`UNSERIALIZABLE_TYPES`	Undocumented
Variable	`copyright_year_re`	Undocumented
Variable	`logger`	Undocumented
Class	`ConfigValue`	Undocumented
Class	`ENUM`	Represents the candidates which a config value should be one of.
Function	`check_confval_types`	Check all values for deviation from the default value's type, since that can result in TypeErrors all over the place NB.
Function	`check_primary_domain`	Undocumented
Function	`check_root_doc`	Adjust root_doc to 'contents' to support an old project which does not have any root_doc setting.
Function	`convert_highlight_options`	Convert old styled highlight_options to new styled one.
Function	`convert_source_suffix`	Convert old styled source_suffix to new styled one.
Function	`correct_copyright_year`	Correct values of copyright year that are not coherent with the SOURCE_DATE_EPOCH environment variable (if set)
Function	`eval_config_file`	Evaluate a config file.
Function	`init_numfig_format`	Initialize :confval:`numfig_format`.
Function	`is_serializable`	Check if object is serializable or not.
Function	`setup`	Undocumented

CONFIG_FILENAME: str =

Undocumented

Value

'conf.py'

UNSERIALIZABLE_TYPES =

Undocumented

Value

(type, types.ModuleType, types.FunctionType)

copyright_year_re =

Undocumented

logger =

Undocumented

def check_confval_types(app, config):

Check all values for deviation from the default value's type, since that can result in TypeErrors all over the place NB.

def check_primary_domain(app, config):

Undocumented

def check_root_doc(app, env, added, changed, removed):

Adjust root_doc to 'contents' to support an old project which does not have any root_doc setting.

def convert_highlight_options(app, config):

Convert old styled highlight_options to new styled one.

def convert_source_suffix(app, config):

Convert old styled source_suffix to new styled one.

def correct_copyright_year(app, config):

Correct values of copyright year that are not coherent with the SOURCE_DATE_EPOCH environment variable (if set)

def eval_config_file(filename, tags):

Evaluate a config file.

def init_numfig_format(app, config):

def is_serializable(obj):

Check if object is serializable or not.

def setup(app):

Undocumented