The Cloud Sphinx Theme documentation has moved to https://cloud-sptheme.readthedocs.io
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.
Deprecated since version 1.7: As of Sphinx 1.2, this is passed to Sphinx via a
setup.pyentry point, and no longer needs to be included in your documentation’sconf.py.
-
cloud_sptheme.get_version(release)¶ Derive short version string from longer ‘release’ string.
This is quick helper which takes a project’s
releasestring, and generates the shortenedversionstring 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)