Development¶
Clone the repository:
git clone https://github.com/readthedocs/readthedocs-sphinx-search
cd readthedocs-sphinx-search/
Install dependencies via npm
:
npm install
Generate minified JS and CSS files via Gulp
:
gulp
Run the test suite with tox
. More information about testing is
available at Testing page.
Releasing¶
Make sure you have the latest version of these packages:
python -m pip install --upgrade setuptools wheel twine
Update the version in sphinx_search/__init__.py
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
Note
Make sure you don’t have any uncommitted changes before releasing.