Update the theme

Updating the Awesome Theme is straightforward for most users. If you use any customization, you might have to update your customizations manually.

Version 4.0

Version 4.0 of the Awesome Theme includes these breaking changes:

Add support for Sphinx 6

Since Sphinx 6 is only supported with the latest version of the myst-parser package and Sphinx 6 drops support for Python 3.7, this release is a major version update.

Apart from that, this version is identical with version 3 of the Awesome Theme.

Version 3.0


Create a better visual hierarchy which makes the document easier to scan. Heavily inspired by the Material Design website.


All JavaScript is now using the Stimulus framework.

Version 2.0

Version 2.0 of the Awesome Theme includes these breaking changes:

Require Sphinx 4 or newer

Sphinx 4 depends on docutils 0.17, which creates more semantic HTML by default. This allows to reduce the amount of custom transformations.

Restructure several templates

The layout use CSS grid. This leads to fewer container elements in the templates.