Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release 1.2.0rc3 #1414

Merged
merged 3 commits into from
Jan 18, 2023
Merged

Release 1.2.0rc3 #1414

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
30de69b
Bump version to 1.2.0rc3
benjaoming Jan 17, 2023
7452b9f
Update changelog with more entries and known issues
benjaoming Jan 17, 2023
29d01a6
Update package-lock
benjaoming Jan 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 18 additions & 3 deletions docs/changelog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,26 +7,41 @@ Changelog
Development version (|development_version|)
===========================================

.. |development_version| replace:: 1.2.0rc2
.. |development_version| replace:: 1.2.0rc3

Dependency changes
------------------

* docutils 0.18 is supported. (#1381)
* Sphinx 6 support added (#1385)
* Sphinx 6 support added
* Added ``sphinxcontrib-jquery`` as a dependency (#1385)
* Python 3.11 is officially supported and tested. (#1395)
* Python 3.4 and 3.5 are officially not supported (#1395)


Note for users of Sphinx<3
Changes
-------

* Automatically use ``sphinxcontrib-jquery`` in Sphinx 6+ (#1399)
* Use new context vars ``logo_url``, ``favicon_url`` and ``root_doc`` when available (#1405)

Note for users of Sphinx<4
--------------------------

If you cannot use a more recent Sphinx release,
you should at least ensure you are using the most recent release for your major version.
Currently, these are Sphinx `1.8.6` and `2.4.5`.
Older releases may install unsupported versions of several dependencies, including Jinja2 and docutils.

Known issues
------------

In some cases, jQuery is not loaded with Sphinx 6 on Read the Docs.
Workaround: You need to add ``sphinx_rtd_theme`` to ``extensions`` in your ``conf.py``.
See `readthedocs.org issue #9654`_ for updates.

.. _readthedocs.org issue #9654: https://github.com/readthedocs/readthedocs.org/pull/9654

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A note on this:

We will release rc3 with this known issue and then work to fix it in RTD before 1.2.0 because we cannot risk users building documentation that looks like it's working but actually doesn't have jQuery and thus have specific small details broken (the RTD Flyout menu for instance)

.. _release-1.1.1:

1.1.1
Expand Down
53 changes: 28 additions & 25 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "sphinx_rtd_theme",
"main": "js/theme.js",
"version": "1.2.0rc2",
"version": "1.2.0rc3",
"scripts": {
"dev": "webpack-dev-server --open --config webpack.dev.js",
"build": "webpack --config webpack.prod.js",
Expand Down
2 changes: 1 addition & 1 deletion setup.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[bumpversion]
current_version = 1.2.0rc2
current_version = 1.2.0rc3
commit = false
tag = false
parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)((?P<release>[a-z]+)(?P<dev>\d+))?
Expand Down
2 changes: 1 addition & 1 deletion setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ def run(self):


setup(
version='1.2.0rc2',
version='1.2.0rc3',
cmdclass={
'update_translations': UpdateTranslationsCommand,
'transifex': TransifexCommand,
Expand Down
2 changes: 1 addition & 1 deletion sphinx_rtd_theme/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
from sphinx.util.logging import getLogger


__version__ = '1.2.0rc2'
__version__ = '1.2.0rc3'
__version_full__ = __version__

logger = getLogger(__name__)
Expand Down