Skip to content

Commit

Permalink
Merge branch 'master' into upperbound-sphinxcontrib-jquery
Browse files Browse the repository at this point in the history
  • Loading branch information
benjaoming committed May 23, 2023
2 parents 707dbda + 2107797 commit 98d1dd6
Show file tree
Hide file tree
Showing 8 changed files with 20 additions and 9 deletions.
9 changes: 8 additions & 1 deletion docs/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 2 additions & 2 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion docs/demo/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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/

Expand Down
2 changes: 1 addition & 1 deletion package.json
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.1alpha1",
"version": "1.2.1",
"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
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[bumpversion]
current_version = 1.2.1alpha1
current_version = 1.2.1
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
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ def run(self):


setup(
version='1.2.1alpha1',
version='1.2.1',
cmdclass={
'update_translations': UpdateTranslationsCommand,
'transifex': TransifexCommand,
Expand Down
6 changes: 5 additions & 1 deletion sphinx_rtd_theme/__init__.py
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.1alpha1'
__version__ = '1.2.1'
__version_full__ = __version__

logger = getLogger(__name__)
Expand Down Expand Up @@ -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__)))
Expand Down

0 comments on commit 98d1dd6

Please sign in to comment.