The Cloud Sphinx Theme¶
This is release 1.8.0 of a small Python package named
cloud_sptheme
. It contains a Sphinx theme
named “Cloud”, and some related Sphinx extensions. Cloud and its extensions
are primarily oriented towards generating html documentation for Python libraries.
It provides numerous small enhancements to make the html documentation html more interactive,
improve the layout on mobile devices, and other enhancements.
Contents¶
See also
Themes¶
- Cloud Sphinx Theme
- the main Sphinx theme provided by this package, and used by this documentation.
Extensions¶
The following Sphinx extensions provide features used by the Cloud theme, and should be enabled for most documentation that uses it:
cloud_sptheme.ext.index_styling
- Adds additional css styling classes to the index page.
cloud_sptheme.ext.relbar_toc
- Adds a TOC link to the top navigation controls.
Generic Extensions¶
This package also provides a few extra Sphinx extensions which may be useful when documenting Python projects; and should be theme-agnostic:
cloud_sptheme.ext.autodoc_sections
- Patches the
sphinx.ext.autodoc
to handle RST section headers inside docstrings.cloud_sptheme.ext.autoattribute_search_bases
- Patches
sphinx.ext.autodoc
so that.. autoattribute::
will also search parent classes for attribute docstrings.cloud_sptheme.ext.docfield_markup
- Patches Sphinx to permit tilde-prefixes markup such as
:raises ~myapp.MyException:
cloud_sptheme.ext.issue_tracker
- Adds a special
:issue:
role for quickly linking to your project’s issue tracker.cloud_sptheme.ext.escaped_samp_literals
- Patches Sphinx to permit escaped
{}
characters within a:samp:
role.cloud_sptheme.ext.page_only
- Directive that allows entire pages to be conditionally omitted from a build, similar to
.. only::
.cloud_sptheme.ext.role_index
- Generates a “roleindex.json” of all document and cross-references, to help integrate sphinx documentation into a web application’s context-aware help.
cloud_sptheme.ext.table_styling
- Enhances
.. table
directive to support per-column text alignment and other layout features.
Reference¶
- Installation Instructions
- requirements and installations instructions
- Release History
- history of current and past releases
Online Resources¶
Homepage: https://bitbucket.org/ecollins/cloud_sptheme Online Docs: http://packages.python.org/cloud_sptheme Download & PyPI: http://pypi.python.org/pypi/cloud_sptheme