cloud_sptheme
- helper functions¶
The main cloud_sptheme
module contains the following helper functions:
-
cloud_sptheme.
get_theme_dir
()¶ Returns path to directory containing this package’s Sphinx themes.
This is designed to be used when setting the
html_theme_path
option within Sphinx’sconf.py
file.See also
The Cloud Sphinx Theme for a usage example.
-
cloud_sptheme.
get_version
(release)¶ Derive short version string from longer ‘release’ string.
This is quick helper which takes a project’s
release
string, and generates the shortenedversion
string required byconf.py
. Usage example forconf.py
:import cloud_sptheme as csp ... # The version info for the project you're documenting from myapp import __version__ as release version = csp.get_version(release)