fqr.docs.enm module

Docs enumerations.

class NoCrawlPath(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Paths to be Disallowed in generated robots.txt files.

search = 'Disallow: /search/'

api = 'Disallow: /api/'

builds = 'Disallow: /builds/'

class SiteMapChangeFreq(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Valid site map change frequencies.

daily = 'daily'

weekly = 'weekly'

monthly = 'monthly'

class SupportedTheme(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Valid sphinx docs themes.

agogo = 'agogo'

alabaster = 'alabaster'

bizstyle = 'bizstyle'

classic = 'classic'

haiku = 'haiku'

nature = 'nature'

pyramid = 'pyramid'

scrolls = 'scrolls'

sphinxdoc = 'sphinxdoc'

traditional = 'traditional'

class Boolean(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Boolean Enumeration.

true = True

false = False

class NoneAlias(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Nones Enumeration.

null = None

none = None

nan = None