Skip to content
This repository was archived by the owner on Apr 8, 2025. It is now read-only.

Commit 1ce5790

Browse files
committed
Simpler steps
1 parent 6aabf51 commit 1ce5790

File tree

1 file changed

+14
-10
lines changed

1 file changed

+14
-10
lines changed

docs/development.rst

+14-10
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ Install dependencies via ``npm``:
1212

1313
.. prompt:: bash
1414

15-
npm install
15+
npm install
1616

1717
Generate minified JS and CSS files via ``Gulp``:
1818

1919
.. prompt:: bash
2020

21-
gulp
21+
gulp
2222

2323
Run the test suite with ``tox``. More information about testing is
2424
available at :doc:`Testing page <testing>`.
@@ -32,16 +32,20 @@ Make sure you have the latest version of these packages:
3232
3333
python -m pip install --upgrade setuptools wheel twine
3434
35-
- Update the version in ``sphinx_search/__init__.py`` and ``package.json``.
36-
- Run ``npm run build`` and ``npm run changelog``.
37-
- Open a pull request with the changes.
35+
Update the version in ``sphinx_search/__init__.py`` and ``package.json``,
36+
and run:
3837

39-
After the pull request is merged, run ``make release``, this will:
38+
.. prompt:: bash
39+
40+
npm run build
41+
npm run changelog
4042

41-
- Checkout and update your master branch.
42-
- Generate the distribution archives in ``dist/``.
43-
- Upload the archives from ``dist/`` to PyPI.
43+
Open a pull request with the changes.
44+
After the pull request is merged, run:
45+
46+
.. prompt:: bash
4447

45-
Now you can tag the release with ``make tag``.
48+
make release
49+
make tag
4650

4751
.. note:: Make sure you don't have any uncommitted changes before releasing.

0 commit comments

Comments
 (0)