diff --git a/docs/changelog.rst b/docs/changelog.rst index 2c01831ec..194bd3dd6 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -4,10 +4,17 @@ Changelog .. seealso:: :ref:`howto_upgrade` +.. _release-1.2.1: + |theme_version| =============== -.. |theme_version| replace:: 1.2.1alpha1 +.. |theme_version| replace:: 1.2.1 + +Fixes +----- + +* Load jQuery correctly when using latest sphinxcontrib-jquery release (#1448) .. _release-1.2.0: diff --git a/docs/contributing.rst b/docs/contributing.rst index 950c971b2..41b91652c 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -251,8 +251,8 @@ To release a new version of the theme, core team will take the following steps: need to commit it to git and tag it together with your release. #. Commit these changes to a pull request. #. Merge the pull request after review. -#. Check out ``master`` branch locally for tagging -#. Tag the release in git: ``git tag $NEW_VERSION``. +#. Check out ``master`` branch locally for tagging. **Remember to pull from remote**. +#. Tag the release in git: ``git tag -s $NEW_VERSION``. #. Push the tag to GitHub: ``git push --tags origin``. #. Upload the package to PyPI: diff --git a/docs/demo/api.rst b/docs/demo/api.rst index ae23df75a..c077a0421 100644 --- a/docs/demo/api.rst +++ b/docs/demo/api.rst @@ -107,7 +107,7 @@ JavaScript API Generated Index =============== -Part of the sphinx build process in generate and index file: :ref:`genindex`. +Part of the sphinx build process is to generate an index file: :ref:`genindex`. Optional parameter args diff --git a/docs/development.rst b/docs/development.rst index c11cf159e..598e6ae47 100644 --- a/docs/development.rst +++ b/docs/development.rst @@ -90,7 +90,7 @@ version: .. code:: console - $ pip install "sphinx_rtd_theme<=2.0.0" + $ pip install "sphinx_rtd_theme<2.0.0" .. _semantic versioning: http://semver.org/ diff --git a/package.json b/package.json index dcb82c517..e8194b3b8 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "sphinx_rtd_theme", "main": "js/theme.js", - "version": "1.2.1alpha1", + "version": "1.2.1", "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 b76d16f89..d24aa07fc 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,5 +1,5 @@ [bumpversion] -current_version = 1.2.1alpha1 +current_version = 1.2.1 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 1b74d3061..8eaba3aa3 100644 --- a/setup.py +++ b/setup.py @@ -86,7 +86,7 @@ def run(self): setup( - version='1.2.1alpha1', + version='1.2.1', cmdclass={ 'update_translations': UpdateTranslationsCommand, 'transifex': TransifexCommand, diff --git a/sphinx_rtd_theme/__init__.py b/sphinx_rtd_theme/__init__.py index 687202418..8ac220a52 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.1alpha1' +__version__ = '1.2.1' __version_full__ = __version__ logger = getLogger(__name__) @@ -58,6 +58,10 @@ def setup(app): # enabled at most once. # See: https://www.sphinx-doc.org/en/master/extdev/appapi.html#sphinx.application.Sphinx.setup_extension app.setup_extension("sphinxcontrib.jquery") + # However, we need to call the extension's callback since setup_extension doesn't do it + # See: https://github.com/sphinx-contrib/jquery/issues/23 + from sphinxcontrib.jquery import add_js_files as jquery_add_js_files + jquery_add_js_files(app, app.config) # Register the theme that can be referenced without adding a theme path app.add_html_theme('sphinx_rtd_theme', path.abspath(path.dirname(__file__)))