diff --git a/docs/changelog.rst b/docs/changelog.rst index 6befbbf87..ec75c6165 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -7,19 +7,25 @@ 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, @@ -27,6 +33,15 @@ you should at least ensure you are using the most recent release for your major 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 + .. _release-1.1.1: 1.1.1 diff --git a/package-lock.json b/package-lock.json index 43ad33bcd..80e37f026 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "sphinx_rtd_theme", - "version": "1.2.0rc2", + "version": "1.2.0rc3", "lockfileVersion": 1, "requires": true, "dependencies": { @@ -527,9 +527,9 @@ "dev": true }, "aws4": { - "version": "1.11.0", - "resolved": "https://registry.npmjs.org/aws4/-/aws4-1.11.0.tgz", - "integrity": "sha512-xh1Rl34h6Fi1DC2WWKfxUTVqRsNnr6LsKz2+hfwDxQJWmrx8+c7ylaqBMcHfl1U1r2dsifOvKX3LQuLNZ+XSvA==", + "version": "1.12.0", + "resolved": "https://registry.npmjs.org/aws4/-/aws4-1.12.0.tgz", + "integrity": "sha512-NmWvPnx0F1SfrQbYwOi7OeaNGokp9XhzNioJ/CSBs8Qa4vxug81mhJEAVZwxXuBmYB5KDRfMq/F3RR0BIU7sWg==", "dev": true }, "balanced-match": { @@ -1030,9 +1030,9 @@ } }, "caniuse-lite": { - "version": "1.0.30001441", - "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001441.tgz", - "integrity": "sha512-OyxRR4Vof59I3yGWXws6i908EtGbMzVUi3ganaZQHmydk1iwDhRnvaPG2WaR0KcqrDFKrxVZHULT396LEPhXfg==", + "version": "1.0.30001445", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001445.tgz", + "integrity": "sha512-8sdQIdMztYmzfTMO6KfLny878Ln9c2M0fc7EH60IjlP4Dc4PiCy7K2Vl3ITmWgOyPgVQKa5x+UP/KqFsxj4mBg==", "dev": true }, "caseless": { @@ -2267,13 +2267,14 @@ } }, "es-abstract": { - "version": "1.21.0", - "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.21.0.tgz", - "integrity": "sha512-GUGtW7eXQay0c+PRq0sGIKSdaBorfVqsCMhGHo4elP7YVqZu9nCZS4UkK4gv71gOWNMra/PaSKD3ao1oWExO0g==", + "version": "1.21.1", + "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.21.1.tgz", + "integrity": "sha512-QudMsPOz86xYz/1dG1OuGBKOELjCh99IIWHLzy5znUB6j8xG2yMA7bfTV86VSqKF+Y/H08vQPR+9jyXpuC6hfg==", "dev": true, "requires": { + "available-typed-arrays": "^1.0.5", "call-bind": "^1.0.2", - "es-set-tostringtag": "^2.0.0", + "es-set-tostringtag": "^2.0.1", "es-to-primitive": "^1.2.1", "function-bind": "^1.1.1", "function.prototype.name": "^1.1.5", @@ -2286,7 +2287,7 @@ "has-proto": "^1.0.1", "has-symbols": "^1.0.3", "internal-slot": "^1.0.4", - "is-array-buffer": "^3.0.0", + "is-array-buffer": "^3.0.1", "is-callable": "^1.2.7", "is-negative-zero": "^2.0.2", "is-regex": "^1.1.4", @@ -2313,12 +2314,13 @@ "dev": true }, "es-set-tostringtag": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/es-set-tostringtag/-/es-set-tostringtag-2.0.0.tgz", - "integrity": "sha512-vZVAIWss0FcR/+a08s6e2/GjGjjYBCZJXDrOnj6l5kJCKhQvJs4cnVqUxkVepIhqHbKHm3uwOvPb8lRcqA3DSg==", + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/es-set-tostringtag/-/es-set-tostringtag-2.0.1.tgz", + "integrity": "sha512-g3OMbtlwY3QewlqAiMLI47KywjWZoEytKr8pf6iTC8uJq5bIAH52Z9pnQ8pVL6whrCto53JZDuUIsifGeLorTg==", "dev": true, "requires": { "get-intrinsic": "^1.1.3", + "has": "^1.0.3", "has-tostringtag": "^1.0.0" } }, @@ -3652,13 +3654,14 @@ } }, "is-array-buffer": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/is-array-buffer/-/is-array-buffer-3.0.0.tgz", - "integrity": "sha512-TI2hnvT6dPUnn/jARFCJBKL1eeabAfLnKZ2lmW5Uh317s1Ii2IMroL1yMciEk/G+OETykVzlsH6x/L4q/avhgw==", + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/is-array-buffer/-/is-array-buffer-3.0.1.tgz", + "integrity": "sha512-ASfLknmY8Xa2XtB4wmbz13Wu202baeA18cJBCeCy0wXUHZF0IPyVEXqKEcd+t2fNSLLL1vC6k7lxZEojNbISXQ==", "dev": true, "requires": { "call-bind": "^1.0.2", - "get-intrinsic": "^1.1.3" + "get-intrinsic": "^1.1.3", + "is-typed-array": "^1.1.10" } }, "is-arrayish": { @@ -4763,9 +4766,9 @@ } }, "object-inspect": { - "version": "1.12.2", - "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.12.2.tgz", - "integrity": "sha512-z+cPxW0QGUp0mcqcsgQyLVRDoXFQbXOwBaqyF7VIgI4TWNQsDHrBpUQslRmIfAoYWdYzs6UlKJtB2XJpTaNSpQ==", + "version": "1.12.3", + "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.12.3.tgz", + "integrity": "sha512-geUvdk7c+eizMNUDkRpW1wJwgfOiOeHbxBR/hLXK1aT6zmVSO0jsQcs7fj6MGw89jC/cjGfLcNOrtMYtGqm81g==", "dev": true }, "object-is": { @@ -5836,9 +5839,9 @@ } }, "punycode": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.1.1.tgz", - "integrity": "sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A==", + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.2.0.tgz", + "integrity": "sha512-LN6QV1IJ9ZhxWTNdktaPClrNfp8xdSAYS0Zk2ddX7XsXZAxckMHPCBcHRo0cTcEIgYPRiGEkmji3Idkh2yFtYw==", "dev": true }, "q": { diff --git a/package.json b/package.json index 77a2ab560..b8e6783d9 100644 --- a/package.json +++ b/package.json @@ -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", diff --git a/setup.cfg b/setup.cfg index f129a00bc..514f18164 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,5 +1,5 @@ [bumpversion] -current_version = 1.2.0rc2 +current_version = 1.2.0rc3 commit = false tag = false parse = (?P\d+)\.(?P\d+)\.(?P\d+)((?P[a-z]+)(?P\d+))? diff --git a/setup.py b/setup.py index eba770ea8..892abe811 100644 --- a/setup.py +++ b/setup.py @@ -86,7 +86,7 @@ def run(self): setup( - version='1.2.0rc2', + version='1.2.0rc3', cmdclass={ 'update_translations': UpdateTranslationsCommand, 'transifex': TransifexCommand, diff --git a/sphinx_rtd_theme/__init__.py b/sphinx_rtd_theme/__init__.py index f4767fba4..74dfff1c1 100644 --- a/sphinx_rtd_theme/__init__.py +++ b/sphinx_rtd_theme/__init__.py @@ -12,7 +12,7 @@ from sphinx.util.logging import getLogger -__version__ = '1.2.0rc2' +__version__ = '1.2.0rc3' __version_full__ = __version__ logger = getLogger(__name__)