sphinx.config

module documentation
(source)

Build configuration file handling.

Class Config Configuration file abstraction.
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
Constant CONFIG_FILENAME Undocumented
Constant UNSERIALIZABLE_TYPES Undocumented
Variable copyright_year_re Undocumented
Variable logger Undocumented
def check_confval_types(app, config): (source)

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

Parameters
app:Sphinx|NoneUndocumented
config:ConfigUndocumented
def check_primary_domain(app, config): (source)

Undocumented

Parameters
app:SphinxUndocumented
config:ConfigUndocumented
def check_root_doc(app, env, added, changed, removed): (source)

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

Parameters
app:SphinxUndocumented
env:BuildEnvironmentUndocumented
added:set[str]Undocumented
changed:set[str]Undocumented
removed:set[str]Undocumented
Returns
set[str]Undocumented
def convert_highlight_options(app, config): (source)

Convert old styled highlight_options to new styled one. * old style: options * new style: a dict which maps from language name to options

Parameters
app:SphinxUndocumented
config:ConfigUndocumented
def convert_source_suffix(app, config): (source)

Convert old styled source_suffix to new styled one. * old style: str or list * new style: a dict which maps from fileext to filetype

Parameters
app:SphinxUndocumented
config:ConfigUndocumented
def correct_copyright_year(app, config): (source)

Correct values of copyright year that are not coherent with the SOURCE_DATE_EPOCH environment variable (if set) See https://reproducible-builds.org/specs/source-date-epoch/

Parameters
app:SphinxUndocumented
config:ConfigUndocumented
def eval_config_file(filename, tags): (source)

Evaluate a config file.

Parameters
filename:strUndocumented
tags:Tags|NoneUndocumented
Returns
dict[str, Any]Undocumented
def init_numfig_format(app, config): (source)

Initialize :confval:`numfig_format`.

Parameters
app:SphinxUndocumented
config:ConfigUndocumented
def is_serializable(obj): (source)

Check if object is serializable or not.

Parameters
obj:AnyUndocumented
Returns
boolUndocumented
def setup(app): (source)

Undocumented

Parameters
app:SphinxUndocumented
Returns
dict[str, Any]Undocumented
CONFIG_FILENAME: str = (source)

Undocumented

Value
'conf.py'
UNSERIALIZABLE_TYPES = (source)

Undocumented

Value
(type, types.ModuleType, types.FunctionType)
copyright_year_re = (source)

Undocumented

logger = (source)

Undocumented