sphinx.theming.HTMLThemeFactory

class documentation

class HTMLThemeFactory:

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.
Method	`load_sphinx_rtd_theme`	Load sphinx_rtd_theme theme (if installed).
Instance Variable	`app`	Undocumented
Instance Variable	`themes`	Undocumented

def __init__(self, app):

Undocumented

Parameters
app:`Sphinx`	Undocumented

def create(self, name):

Create an instance of theme.

def find_themes(self, theme_path):

Search themes from specified directory.

def load_additional_themes(self, theme_paths):

Load additional themes placed at specified directories.

Parameters
theme_paths:`str`	Undocumented

def load_alabaster_theme(self):

Load alabaster theme.

def load_builtin_themes(self):

Load built-in themes.

def load_external_theme(self, name):

Try to load a theme using entry_points.

Sphinx refers to sphinx_themes entry_points.

Parameters
name:`str`	Undocumented

def load_extra_theme(self, name):

Try to load a theme with the specified name.

Parameters
name:`str`	Undocumented

def load_sphinx_rtd_theme(self):

Load sphinx_rtd_theme theme (if installed).

app =

Undocumented

themes =

Undocumented