Announcing sphinx_rtd_theme 1.1.0¶
We are happy to announce the release of new version of our theme, sphinx-rtd-theme. In this release, we have focused on bug fixes, backwards compatibility, and making the way for future releases.
Changes and new features 💄¶
Visually, we have a couple of small tweaks that most people won’t notice unless we mention them here 😇 The objective of the 1.1 release is to maintain backwards compatibility, and that also goes for the visual parts.
<kbd>tag now has a nicer styling.
Breadcrumb styling has been updated.
Table cells with multiple paragraphs now have a correct formatting.
Definition lists are rendered correctly in API docs.
Issues with citation rendering and styling fixed.
Long URLs break into several lines instead of overflowing.
In the engine room, we have ensured the long-term stability for users of this theme release by putting upper bounds on
We also fixed an issue that caused the theme to fail when Sphinx
5.2.0.post0 was released and will ensure that this doesn’t happen again.
How to upgrade¶
If you are using the theme for the first time, please refer the general installation instructions.
For most projects, including projects hosted on Read the Docs, the general update instruction is to modify your project’s dependencies (often stored in
requirements.txt) where you should add
sphinx-rtd-theme==1.1.0 (or replace any existing entries).
If you have a project on Read the Docs without a Python requirements file
requirements.txt, you need to add one in order to use newer versions of sphinx-rtd-theme.
You can read more about adding a
requirements.txt in our Documentation about Reproducible Builds.
Each little change comes with an overhead of testing, perfection and a long list of legacy support. We are addressing all that in upcoming releases, so it will become less cumbersome to add new features. The building and testing processes are refined and future releases will drop some of the legacy.
Here are the highlights from our roadmap:
sphinx-rtd-theme 1.2: Address jQuery removal from Sphinx, adds docutils 0.18 support, possibly also docutils 0.19 support
sphinx-rtd-theme 2.0: Adds Sphinx 6.x support, dropping legacy support for several Sphinx releases and old browsers.
If you wish to see more details, view the full roadmap.
If you experience any issues with the theme, we welcome you to visit the GitHub repository readthedocs/sphinx-rtd-theme.
For support questions, consider asking in one of the Read the Docs community support channels.