Skip to content

Commit 29c97e4

Browse files
committed
Update note on how to build docs for a release
1 parent af64a43 commit 29c97e4

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,9 +90,11 @@ Making a release
9090
----------------
9191

9292
The process to make a release is the following:
93+
* Using a virtual env with the following tool installed: `pip install build sphinx twine`
94+
* In that same virtual env, install paho itself (required for docs): `pip install -e .`
9395
* Update the Changelog with the release version and date. Ensure it's up-to-date with latest fixes & PRs merged.
9496
* Make sure test pass, check that Github actions are green.
95-
* Check that documentation build (`cd docs; make html`)
97+
* Check that documentation build (`cd docs; make clean html`)
9698
* Bump the version number in ``paho/mqtt/__init__.py``, commit the change.
9799
* Make a dry-run of build:
98100
* Build using hatch: ``python -m hatch build``

0 commit comments

Comments
 (0)