I've released version 0.0.9 of the Sizzle theme on PyPI. To use it, simply do
pip install sphinx_sizzle_theme
and then specify
sizzle as your Sphinx theme.
This release introduces some new features. Changes:
* Terms in the glossary can now be permalinked.
* When browsing documentation, glossary terms can now show a tooltip with the term
definition.
* The contents of code blocks with captions can now be copied to the clipboard with a
single click.
* Documentation can now contain customizable tooltips.
Theme highlights:
* Layout uses a small header with search box, prev/next links and index link
* Sidebar is hideable and showable with keyboard or mouse
* Entries in the TOC can be filtered by typing in what you want to match on -
handy for long TOCs / larger projects
* Sidebar and content area can scroll independently (useful for larger projects)
* Typography changes - Font Awesome is integrated, slightly more condensed fonts
than are used in Guzzle (e.g. Roboto rather than Open Sans)
* Support for additional Google Fonts
* Styled lists using Font Awesome icons
* Summary/detail functionality using styled lists
* A couple of custom roles, including one for Font Awesome icons
* Tooltips in your documentation that you can customize.
* Improved hooks for your custom JavaScript to be called on document load, etc.
You can see an example of the theme using its own documentation:
https://docs.red-dove.com/sphinx_sizzle_theme/and for a larger project:
https://docs.red-dove.com/distlib/I'd be grateful for any feedback about the theme and/or its documentation.
The development repository is currently at
https://bitbucket.org/vinay.sajip/sphinx_sizzle_theme/and issues can also be raised there.
Regards,
Vinay Sajip