PSphinxTheme.utils - helper functions

Overview

This module defines a couple of helper functions.

Functions

PSphinxTheme.utils.set_psphinxtheme(name)

Returns P-SphinxTheme related basic settings and checks also if name is a valid PSphinxTheme name.

This is designed to be used within Sphinx’s conf.py file.

SeeAlso

The P-SphinxTheme Usage Example.

param name:(str) a valid P-SphinxTheme theme name return:(tuple) [html_theme_path], html_theme, needs_sphinx

PSphinxTheme.utils.get_psphinxtheme_root_dir()

Returns:(str) path of the P-SphinxTheme root dir

PSphinxTheme.utils.is_p_sphinx_theme(name)

Returns:(bool) True if name is a valid P-SphinxTheme theme name.