sphinx.config.ENUM

class documentation

class ENUM: (source)

Represents the candidates which a config value should be one of. Example: app.add_config_value('latex_show_urls', 'no', None, ENUM('no', 'footnote', 'inline'))

Method	`__init__`	Undocumented
Method	`match`	Undocumented
Instance Variable	`candidates`	Undocumented

def __init__(self, *candidates): (source) ¶

Undocumented

Parameters
*candidates:`str`	Undocumented

def match(self, value): (source) ¶

Undocumented

Parameters
value:`(str\|list)\|tuple`	Undocumented
Returns
`bool`	Undocumented

candidates = (source) ¶

Undocumented