Clone the repository:

git clone
cd readthedocs-sphinx-search/

Install dependencies via npm:

npm install

Generate minified JS and CSS files via Gulp:


Run the test suite with tox. More information about testing is available at Testing page.


Make sure you have the latest version of these packages:

python -m pip install --upgrade setuptools wheel twine

Update the version in sphinx_search/ and package.json, and run:

npm run build
npm run changelog

Open a pull request with the changes. After the pull request is merged, run:

make release
make tag


Make sure you don’t have any uncommitted changes before releasing.