The Cloud Sphinx Theme documentation has moved to https://cloud-sptheme.readthedocs.io
cloud_sptheme.ext.index_styling
- improves css styling for genindex¶
Overview¶
This Sphinx extension intercepts & modifies the general index data before it is rendered to html, adding some additional css classes to help Sphinx themes (e.g. “Cloud” sphinx theme) provide additional per-type styling for index entries.
Internals¶
This extension adds the following css classes to genindex.html
:
- For all entries referencing an
attribute
,method
,class
,function
, ormodule
:- The text containing the type of the entry (e.g.
attribute
ormethod
) is wrapped in a<span class="category type">...</span>
tag. - If the entry contains a location (e.g.
myclass in module myapp
), themyapp
portion is wrapped in a<span class="location">...</span>
tag.
- The text containing the type of the entry (e.g.
- Entries which don’t fit into one of the above categories are not modified.