sphinx.config.ENUM

class documentation

class ENUM:

View In Hierarchy

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):

Undocumented

Parameters
*candidates:strUndocumented
def match(self, value):

Undocumented

Parameters
value:Union[str, List, Tuple]Undocumented
Returns
boolUndocumented
candidates =

Undocumented