sphinx.theming.Theme

class documentation

class Theme:

View In Hierarchy

A Theme is a set of HTML templates and configurations.

This class supports both theme directory and theme archive (zipped theme).

Method __init__ Undocumented
Method cleanup Remove temporary directories.
Method get​_config Return the value for a theme configuration setting, searching the base theme chain.
Method get​_options Return a dictionary of theme options and their values.
Method get​_theme​_dirs Return a list of theme directories, beginning with this theme's, then the base theme's, then that one's base theme's, etc.
Instance Variable base Undocumented
Instance Variable config Undocumented
Instance Variable name Undocumented
Instance Variable rootdir Undocumented
Instance Variable themedir Undocumented
def __init__(self, name, theme_path, factory):

Undocumented

Parameters
name:strUndocumented
theme​_path:strUndocumented
factory:HTMLThemeFactoryUndocumented
def cleanup(self):
Remove temporary directories.
def get_config(self, section, name, default=NODEFAULT):
Return the value for a theme configuration setting, searching the base theme chain.
Parameters
section:strUndocumented
name:strUndocumented
default:AnyUndocumented
Returns
AnyUndocumented
def get_options(self, overrides={}):
Return a dictionary of theme options and their values.
Parameters
overrides:Dict[str, Any]Undocumented
Returns
Dict[str, Any]Undocumented
def get_theme_dirs(self):
Return a list of theme directories, beginning with this theme's, then the base theme's, then that one's base theme's, etc.
Returns
List[str]Undocumented
base =

Undocumented

config =

Undocumented

name =

Undocumented

rootdir =

Undocumented

themedir =

Undocumented