Many documentation projects depend on sphinx-rtd-theme
without specifying a version of the theme (unpinned) while also depending on unpinned versions of Sphinx. The latest version of sphinx-rtd-theme
ideally always supports the latest version of Sphinx, but this is now guaranteed.
This release adds upper bounds to direct dependencies Sphinx
, docutils
and Jinja2
, which will safeguard from mixing with possibly incompatible future versions of Sphinx & friends.
- Sphinx versions supported: 1.6 to 5.2.x
Jinja<3.1
(#1316)Sphinx<6
(#1332)
- Nicer styles for <kbd> (#967)
- Suffixes in Sphinx version caused build errors (#1345)
- Table cells with multiple paragraphs gets wrong formatting (#289)
- Definition lists rendered wrongly in api docs (#1052)
- Citation not styled properly (#1078)
- Sphinx 5.2 added to test matrix (#1348)
- Python 3.10 added to test matrix (#1334)
- Supplemental Docker setup for development (#1319)
- Most of setup.py migrated to setup.cfg (#1116)
There are no known incompatible changes in this release. Support for docutils
versions 0.18 and 0.19 are scheduled for our next release.
- The minimum supported python version is now 2.7 or 3.4 and greater (#1093)
- The minimum supported Sphinx version is now 1.6 (#1091)
- Support for Sphinx's HTML4 writer is deprecated and will be removed in version 2.0 (#1091)
- Add support for Sphinx 4.x (#1123)
- Add support for Docutils 0.17 (#1185 and #1199)
- Fixed logo scaling on IE11 (#1183)
- Added support for logos as URLs (#1171)
- Align top and side navigation background colors on mobile (#1132)
- Added support for deep toc levels (#1089)
- Updated translations for Chinese, Dutch, Estonian, French, German, Italian, Lithuanian, Persian, Polish, Portuguese, Russian, Spanish, Swedish, and Turkish locales
A number of accessibility features were added in this release:
- Allow keyboard to toggle menu expansion (#1167)
- Allow keyboard to activate permalink (#1162)
- Show keyboard focus on buttons (#1161)
- Maintain aria-expanded along with .current in menu (#1151)
- Respect tab order for prev/next buttons (#1051)
- Updated Google analytics integration (#1129)
- Add classifier separation on Sphinx 2+ HTML4 writer (#1192)
- Added missing space char in footer (#1188)
- Fix navigation right padding on level2+ elements (#1068)
- Fix navigation expansion button sizes (#1067)
- Wrap inline literals (#1050)
- Fix aria labels (#1056)
- Don't toggle navigation terminal nodes (#1049)
- Fix
<pre>
overflow (#1220) - Fix literal/ref style inside
<dl>
(#1088)
- Update npm development dependencies (#1096)
- Don't require npm to build from source (#1039)
- Use regular toctree instead of toc for singlehtml builder (#507)
- Cleanup whitespace in templates (#1060)
- Date
April 5, 2021
Note
This commit will not be in master
, but was branched directly off 0.5.1
to minimize issues. The next full release will contain all PR's previously merged.
- Depend on docutils < 0.17 (#1113)
- Date
January 4, 2021
- Set
url_root
properly on index (#1025) - Do not load
language_data.js
in non-search pages (#1021) - Hide the search box on any
singlehtml
like builder (#975) - Fix
vcs_pageview_mode
template parameter (#1010) - Mark nex/prev icons as aria-hidden (#1007)
- Use well-formed XML syntax (#1006)
- Footer: show both
commit
andlast_updated
if available (#897) - Search page: don't show "edit on" links (#935)
- New theme option to enable anonymous ip addresses when using Google Analytics (#889)
- The
canonical_url
option was deprecated in favor of Sphinx'shtml_baseurl
(#1003) - Add
contentinfo
block tofooter.html
template (#896) - Make Copyright template match sphinx's basic (#933)
- Packaging: include
bin/preinstall.js
(#1005)
- Date
Jun 17, 2020
- Fix bullet list spacing to respect simple/complex list styles
- Date
June 5, 2020
- Fix issue with simple definition lists that was missed
- Change FOUT back to FOIT
- Fix several margin issues with lists, nested lists, and nested content
- Add colon back to field lists
- Date
May 6, 2020
- Fix many styling issues that look different when using the Sphinx HTML5 writer
- Add the
navigation
template block around the navigation area. - Added i18n support using Babel
- Added translations for 10 new languages
- Moved build system from Grunt and friends to Webpack
- Remove Modernizr, but keep html5shiv (#724, #525)
- Date
Feb 12, 2019
- Fix scrolling to active item in sidebar on load (#214)
- Style caption link for code and literal blocks
- Fix inconsistent font size and line height for autodoc "raises" and "returns" (#267)
- Fix last_updated notice appearing in same line as copyright notice (#704)
- Date
Oct 5, 2018
- Set base font size on <html> (#668)
- Fix HTML search not working with Sphinx-1.8 (#672)
- Upload signed packages to PyPI with twine (#651)
- Do not enforce period at the end of copyright statement (666)
- Date
July 27, 2018
- Line height adjustments for Liberation Mono (#656)
- Add Sphinx as a dependency
This version made some changes to how JS and CSS were included when the theme is used on Read the Docs.
- Do not rely on readthedocs.org for CSS/JS (#614)
- Color accessibility improvements on the left navigation
- Write theme version and build date at top of JavaScript and CSS
- Changed code and literals to use a native font stack (#612)
- Fix small styling issues
- Revert part of #576 causing display issues with version selector menu
- Backwards compatibility fixes for pre-0.3.0 releases (#623)
- Fix mkdocs version selector (#622)
- Add open list spacing (#591)
- Fix table centering (#599)
Note: this version resulted in some JavaScript incompatibilities when used on readthedocs.org
- Add html language attribute
- Allow setting 'rel' and 'title' attributes for stylesheets (#551)
- Add option to style external links
- Add github, gitlab, bitbucket page arguments option
- Add pygments support
- Add setuptools entry point allowing to use
sphinx_rtd_theme
as Sphinxhtml_theme
directly. - Add language to the JS output variable
- Fix some HTML warnings and errors
- Fix many styling issues
- Fix many sidebar glitches
- Fix line number spacing to align with the code lines
- Hide Edit links on auto created pages
- Include missing font files with the theme
- Significant improvement of our documentation
- Compress our Javascript files
- Updated dependencies
- Yet another patch to deal with extra builders outside Spinx, such as the singlehtml builders from the Read the Docs Sphinx extension
- Temporarily patch Sphinx issue with
singlehtml
builder by inspecting the builder in template.
- Roll back toctree fix in 0.2.1 (#367). This didn't fix the issue and introduced another bug with toctrees display.
- Add the
rel
HTML attribute to the footer links which point to the previous and next pages. - Fix toctree issue caused by Sphinx singlehtml builder (#367)
- Adds the
comments
block after thebody
block in the template - Added "Edit on GitLab" support
- Many bug fixes
Note
This is a pre-release version
- Removes Sphinx dependency
- Fixes hamburger on mobile display
- Adds a
body_begin
block to the template - Added
prev_next_buttons_location
- Intermittent scrollbar visibility bug fixed. This change introduces a backwards incompatible change to the theme's layout HTML. This should only be a problem for derivative themes that have overridden styling of nav elements using direct descendant selectors. See #215 for more information.
- Safari overscroll bug fixed
- Version added to the nav header
- Revision id was added to the documentation footer if you are using RTD
- An extra block,
extrafooter
was added to allow extra content in the document footer block - Fixed modernizr URL
- Small display style changes on code blocks, figure captions, and nav elements
- Start keeping changelog :)
- Support for third and fourth level headers in the sidebar
- Add support for Sphinx 1.3
- Add sidebar headers for :caption: in Sphinx toctree
- Clean up sidebar scrolling behavior so it never scrolls out of view