About

This pages lists assets that the Awesome Theme uses to be awesome.

To see the full list of dependencies, see these files:

Feature

Name/Website

License

CSS framework

Tailwind

MIT License

Copy to clipboard

Clipboard.js

MIT License

Fonts

Roboto

Apache License, Version 2.0

JetBrains Mono

SIL Open Font License, 1.1

Icons

Material icons

Apache License, Version 2.0

Tooltips

Primer/CSS

MIT License

Note: versions ≤ 1.13.1 used these icons instead:

Entypo by Daniel Bruce

Creative Commons Attribution-ShareAlike 4.0

Zondicons by Steve Schoger

?

Illustrations

undraw.co

custom

Breaking changes

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

Version 5.0

Version 5.0 of the Awesome Theme includes these breaking changes:

Remove support for html_collapsible_definitions

The user experience was bad for reference documentation, with users having to expand every object, only to see one comment line. Use the sphinx-design extension instead. The collapsible directive gives you more control.

No external link icons by default

By default, no icons are shown. Set html_awesome_code_headers to True to show icons for external links. In previous versions, external links always included an icon.

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

Redesign

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

Restructure

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.