Themes and extensions
Themes and extensions#
We learned the hard way that maintaining the design and features of documentation is a lot of work. To make all documentation maintainable, we use actively developed themes and extensions to build the documentation.
When customizing the theme, we use Sphinx Book Theme, which in turn depends on PyData Sphinx Theme. See their documentation for features, tips, and tricks that you might want to include in your documentation.
We minimize the customizations of these themes as much as possible.
The one large customization is the search filter by part of the documentation, implemented in modifcations to the templates,
_static/searchtools.js, and the CSS file
We use several MyST and Sphinx extensions to enhance the presentation of Plone documentation.
deflistsupports definition lists.
linkifyidentifies "bare" web URLs and adds hyperlinks.
colon_fencesupports the use of three colons
:::as delimiters to denote code fences, instead of three backticks
substitutionsupports the use of substitutions with Jinja2.
html_imagesupports the use of HTML
sphinx.ext.intersphinxprovides linking between separate projects that use Sphinx for documentation.
sphinx.ext.todoadds support for todo items.
sphinx_copybuttonadds a little "copy" button to the right of code blocks.
sphinx-designadds grids, cards, icons, badges, buttons, tabs, and dropdowns.
sphinxcontrib-httpdomainby generating RESTful HTTP API call examples for different tools from a single HTTP request example. Supported tools include curl, wget, httpie, and python-requests. It is used by Plone's REST API.
sphinxcontrib.videoallows you to embed local videos as defined by the HTML5 standard.