readthedocs · Nov 8, 2021 · Nov 8, 2021 · Nov 8, 2021 · Nov 8, 2021 · Nov 8, 2021
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -11,7 +11,7 @@ commands:
         type: string
       sphinx-version:
         type: string
-        default: "1,2,3,latest"
+        default: "1,2,3,4,latest"
     steps:
       - browser-tools/install-browser-tools
       - checkout
@@ -48,11 +48,19 @@ jobs:
     steps:
       - run-tox:
           version: py39
+  py310:
+    docker:
+      - image: 'cimg/python:3.10-browsers'
+    steps:
+      - run-tox:
+          version: py310
+          sphinx-version: 4,latest
 
 workflows:
   version: 2
   tests:
     jobs:
+      - py310
       - py39
       - py38
       - py37

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,20 @@
+version: 2
+
+build:
+  os: "ubuntu-20.04"
+  tools:
+    # sphinx-js isn't compatible with python 3.10.
+    # https://github.com/mozilla/sphinx-js/issues/186
+    python: "3.9"
+    nodejs: "16"
+
+python:
+  install:
+    - method: pip
+      path: .
+    - requirements: docs/requirements.txt
+
+sphinx:
+  configuration: docs/conf.py
+
+formats: []
diff --git a/.readthedocs.yml b/.readthedocs.yml
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,3 +1,19 @@
+Version 0.1.2
+-------------
+
+:Date: May 11, 2022
+
+* `@ericholscher <https://github.com/ericholscher>`__: Improve SEO of README & docs index (`#111 <https://github.com/readthedocs/readthedocs-sphinx-search/pull/111>`__)
+* `@dependabot[bot] <https://github.com/dependabot[bot]>`__: Bump moment from 2.29.1 to 2.29.2 (`#110 <https://github.com/readthedocs/readthedocs-sphinx-search/pull/110>`__)
+* `@stsewd <https://github.com/stsewd>`__: Test with sphinx 4 and python 3.10 (`#109 <https://github.com/readthedocs/readthedocs-sphinx-search/pull/109>`__)
+* `@stsewd <https://github.com/stsewd>`__: Add sphinx metadata (`#108 <https://github.com/readthedocs/readthedocs-sphinx-search/pull/108>`__)
+* `@dependabot[bot] <https://github.com/dependabot[bot]>`__: Bump minimist from 1.2.5 to 1.2.6 (`#107 <https://github.com/readthedocs/readthedocs-sphinx-search/pull/107>`__)
+* `@stsewd <https://github.com/stsewd>`__: Rename master -> main (`#106 <https://github.com/readthedocs/readthedocs-sphinx-search/pull/106>`__)
+* `@stsewd <https://github.com/stsewd>`__: Docs: use sphinx 4.x (`#105 <https://github.com/readthedocs/readthedocs-sphinx-search/pull/105>`__)
+* `@astrojuanlu <https://github.com/astrojuanlu>`__: Fix docs (`#102 <https://github.com/readthedocs/readthedocs-sphinx-search/pull/102>`__)
+* `@dependabot[bot] <https://github.com/dependabot[bot]>`__: Bump postcss from 7.0.35 to 7.0.39 (`#100 <https://github.com/readthedocs/readthedocs-sphinx-search/pull/100>`__)
+* `@dependabot[bot] <https://github.com/dependabot[bot]>`__: Bump path-parse from 1.0.6 to 1.0.7 (`#99 <https://github.com/readthedocs/readthedocs-sphinx-search/pull/99>`__)
+
 Version 0.1.1
 -------------
 

diff --git a/Makefile b/Makefile
@@ -1,12 +1,12 @@
 release: clean
-	git checkout master
-	git pull origin master
+	git checkout main
+	git pull origin main
 	python setup.py sdist bdist_wheel
 	python -m twine upload --sign --identity security@readthedocs.org dist/*
 
 tag:
-	git checkout master
-	git pull origin master
+	git checkout main
+	git pull origin main
 	git tag `python -c "print(__import__('sphinx_search').__version__)"`
 	git push --tags
 

diff --git a/README.rst b/README.rst
@@ -1,9 +1,9 @@
-readthedocs-sphinx-search
-=========================
+readthedocs-sphinx-search - Search as you type for Read the Docs
+================================================================
 
 |pypi| |docs| |license| |build-status|
 
-`Sphinx`_ extension to enable *search as you type* within a full-page search UI for docs hosted on `Read the Docs`_.
+``readthedocs-sphinx-search`` is a `Sphinx`_ extension to enable *search as you type* for docs hosted on `Read the Docs`_.
 Try it at https://readthedocs-sphinx-search.readthedocs.io/en/latest/?rtd_search=testing.
 
 .. _Sphinx: https://www.sphinx-doc.org/

diff --git a/docs/conf.py b/docs/conf.py
@@ -191,3 +191,7 @@
 def setup(app):
   app.add_object_type('confval', 'confval',
     'pair: %s; configuration value')
+
+  # Install necessary NPM dependencies
+  import subprocess
+  subprocess.check_output(["npm", "install", "-g", "jsdoc"])
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,6 +1,11 @@
-sphinx==3.5.1
-sphinx-prompt==1.1.0
-sphinx-tabs==2.0.1
-sphinx-rtd-theme==0.4.3
-sphinx-notfound-page==0.3
+sphinx==4.5.0
+sphinx-prompt==1.5.0
+sphinx-tabs==3.2.0
+sphinx-rtd-theme==1.0.0
+sphinx-notfound-page==0.8
 sphinx-js==3.1
+
+# sphinx-js pins jinja to a version that doesn't
+# pin its version of markupsafe, markupsafe>=2.1
+# isn't compatible with that version of jinja.
+markupsafe==2.0.1
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "readthedocs-sphinx-search",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Enable search-as-you-type feature.",
   "scripts": {
     "build": "gulp",

diff --git a/sphinx_search/__init__.py b/sphinx_search/__init__.py
@@ -1 +1 @@
-__version__ = '0.1.1'
+__version__ = '0.1.2'
diff --git a/sphinx_search/extension.py b/sphinx_search/extension.py
@@ -1,5 +1,6 @@
 import os
 
+from sphinx_search import __version__
 from sphinx.errors import ExtensionError
 from sphinx.util.fileutil import copy_asset
 
@@ -45,3 +46,9 @@ def setup(app):
 
     app.connect('builder-inited', inject_static_files)
     app.connect('build-finished', copy_asset_files)
+
+    return {
+        'version': __version__,
+        'parallel_read_safe': True,
+        'parallel_write_safe': True,
+    }
diff --git a/tox.ini b/tox.ini
@@ -1,7 +1,8 @@
 [tox]
 minversion = 3.10
 envlist =
-  py{36,37,38,39}-sphinx{1,2,3,latest}
+  py{36,37,38,39}-sphinx{1,2,3,4,latest}
+  py310-sphinx{4,latest}
   docs
 skipsdist = True
 
@@ -13,6 +14,9 @@ deps =
   sphinx1: Sphinx<2.0
   sphinx2: Sphinx<3.0
   sphinx3: Sphinx<4.0
+  sphinx4: Sphinx<5.0
+  {sphinx1,sphinx2,sphinx3}: docutils<0.18
+  {sphinx1,sphinx2,sphinx3}: jinja2<3.1
   sphinxlatest: Sphinx
 commands = pytest {posargs}