IntenseWebs/sphinx_rtd_theme
3
0
Fork 0
mirror of https://github.com/readthedocs/sphinx_rtd_theme.git synced 2025-02-25 18:55:21 -06:00
Code Issues Packages Projects Releases Wiki Activity

Adds changelog for 1.1.0alpha1 (#1353)

Browse Source 
* Adds changelog for 1.1.0alpha1

* Update docs/changelog.rst

Co-authored-by: Anthony <aj@ohess.org>

Co-authored-by: Anthony <aj@ohess.org>
This commit is contained in:
Benjamin Balder Bach 2022-10-07 21:53:50 +02:00 committed by GitHub
parent b98a7de83d
commit b33f27cf95
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 47 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
docs/changelog.rst
View File

@ -5,7 +5,53 @@ Changelog
Development version (|development_version|)
===========================================
.. |development_version| replace:: 1.0.1alpha1
.. |development_version| replace:: 1.1.0alpha1
.. _release-1.1.0alpha1:
1.1.0alpha1
===========
Dependency Changes
------------------
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)
Features
--------
* Nicer styles for <kbd> (#967)
Fixes
-----
* 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)
Minor changes
-------------
* 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)
Incompatible Changes
--------------------
There are no known incompatible changes in this release. Support for ``docutils`` versions 0.18 and 0.19 are scheduled for our next release.
.. _release-1.0.0: