sphinx.theming.HTMLThemeFactory

class documentation

class HTMLThemeFactory: (source)

View In Hierarchy

A factory class for HTML Themes.

Method __init__ Undocumented
Method create Create an instance of theme.
Method find_themes Search themes from specified directory.
Method load_additional_themes Load additional themes placed at specified directories.
Method load_alabaster_theme Load alabaster theme.
Method load_builtin_themes Load built-in themes.
Method load_external_theme Try to load a theme using entry_points.
Method load_extra_theme Try to load a theme with the specified name.
Instance Variable app Undocumented
Instance Variable themes Undocumented
def __init__(self, app): (source)

Undocumented

Parameters
app:SphinxUndocumented
def create(self, name): (source)

Create an instance of theme.

Parameters
name:strUndocumented
Returns
ThemeUndocumented
def find_themes(self, theme_path): (source)

Search themes from specified directory.

Parameters
theme_path:strUndocumented
Returns
dict[str, str]Undocumented
def load_additional_themes(self, theme_paths): (source)

Load additional themes placed at specified directories.

Parameters
theme_paths:strUndocumented
def load_alabaster_theme(self): (source)

Load alabaster theme.

def load_builtin_themes(self): (source)

Load built-in themes.

def load_external_theme(self, name): (source)

Try to load a theme using entry_points. Sphinx refers to ``sphinx_themes`` entry_points.

Parameters
name:strUndocumented
def load_extra_theme(self, name): (source)

Try to load a theme with the specified name.

Parameters
name:strUndocumented
app = (source)

Undocumented

themes = (source)

Undocumented