Merge branch 'master' into clean-up-css

Author: stsewd

.gitignore

@@ -221,5 +221,4 @@ typings/
 # Custom
 
 .vscode/
-package-lock.json
 _build/

Makefile

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

docs/requirements.txt

@@ -1,6 +1,6 @@
-sphinx==1.8.5
+sphinx==3.5.1
 sphinx-prompt==1.1.0
-sphinx-tabs==1.1.10
+sphinx-tabs==2.0.1
 sphinx-rtd-theme==0.4.3
 sphinx-notfound-page==0.3
-sphinx-js==2.7.1
+sphinx-js==3.1

docs/testing.rst

@@ -4,86 +4,59 @@ Testing
 Testing is done using `Selenium WebDriver`_ for automating browser tests.
 `Tox`_ is used to execute testing procedures.
 
-Before running all tests locally, `ChromeDriver`_ (for testing on Chrome browser)
-and `GeckoDriver`_ (for testing on Firefox browser) are required.
+Before running all tests locally, `ChromeDriver`_ (for testing on Chrome)
+and `GeckoDriver`_ (for testing on Firefox) are required.
 
 Install Tox via pip:
 
 .. prompt:: bash
 
-    pip install tox
+   pip install tox
 
 Download and setup the ChromeDriver:
 
 .. literalinclude:: ../scripts/setup_chromedriver.sh
-    :language: bash
+   :language: bash
 
 Download and setup the GeckoDriver:
 
 .. literalinclude:: ../scripts/setup_geckodriver.sh
-    :language: bash
+   :language: bash
 
 To run the full test suite against your changes, simply run Tox.
 Tox should return without any errors.
 You can run Tox against all of our environments and both browsers by running:
 
 .. prompt:: bash
 
-    tox
+   tox
 
 To run tests with a specific environment and for both browsers:
 
 .. prompt:: bash
 
-    tox -e py36-sphinx20
+   tox -e py36-sphinx20
 
 To run tests with a specific environment and for a specified browser:
 
 .. prompt:: bash
 
-    tox -e py36-sphinx20 -- --driver Chrome  # run tests with Python 3.6 and Sphinx < 2.1 with Chrome browser
-    tox -e py36-sphinx20 -- --driver Firefox  # run tests with Python 3.6 and Sphinx < 2.1 with Firefox browser
+   tox -e py36-sphinx20 -- --driver Chrome  # run tests with Python 3.6 and Sphinx < 2.1 with Chrome browser
+   tox -e py36-sphinx20 -- --driver Firefox  # run tests with Python 3.6 and Sphinx < 2.1 with Firefox browser
 
 To run tests against all environments but with a specified browser:
 
 .. prompt:: bash
 
-    tox -- --driver Chrome  # run tests with all environments with Chrome browser
-    tox -- --driver Firefox  # run tests with all environments with Firefox browser
+   tox -- --driver Chrome  # run tests with all environments with Chrome browser
+   tox -- --driver Firefox  # run tests with all environments with Firefox browser
 
-The ``tox`` configuration has the following environments configured.
-You can target a single environment to limit the test suite:
+Internet Explorer and Edge
+--------------------------
 
-.. code-block:: text
-
-    py36-sphinx18
-        Run test suite with Python 3.6 and Sphinx<1.9
-
-    py36-sphinx20
-        Run test suite with Python 3.6 and Sphinx<2.1
-
-    py36-sphinx21
-        Run test suite with Python 3.6 and Sphinx<2.2
-
-    py37-sphinx18
-        Run test suite with Python 3.7 and Sphinx <1.9
-
-    py37-sphinx20
-        Run test suite with Python 3.7 and Sphinx<2.1
-
-    py37-sphinx21
-        Run test suite with Python 3.7 and Sphinx<2.2
-
-    docs
-        Test documentation compilation with Sphinx
-
-
-Continuous Integration
-----------------------
-
-For every push to GitHub, Travis CI runs all the tests.
-You can check the current build status:
-https://travis-ci.org/readthedocs/readthedocs-sphinx-search
+Internet Explorer and Edge don't support headless mode,
+but we can check that everything works with 
+https://saucelabs.com/.
 
 
 .. _Selenium WebDriver: https://seleniumhq.github.io/selenium/docs/api/py/index.html