Skip to content

Commit

Permalink
Drop markdown build from git repository
Browse files Browse the repository at this point in the history
  • Loading branch information
PierreF committed Feb 6, 2024
1 parent fb1b93b commit 87ce6f6
Show file tree
Hide file tree
Showing 6 changed files with 4 additions and 2,397 deletions.
5 changes: 1 addition & 4 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -58,10 +58,7 @@ tests/ssl/signingCA
*.log

# Sphinx documentation
docs/_build/*
# Before we found a place to host build documentation,
# we will use Github repository to serve the markdown time.
!/docs/_build/markdown
docs/_build/

# PyBuilder
target/
Expand Down
3 changes: 3 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,5 +106,8 @@ The process to make a release is the following:
* Then upload the dist file, you can follow instruction on https://packaging.python.org/en/latest/tutorials/packaging-projects/#uploading-the-distribution-archives
It should mostly be ``python -m twine upload dist/*``
* Create a release on Github, copy-pasting the release note from Changelog.
* Build and publish the documentation
* To build the documentation, run `make clean html` in `docs` folder
* Copy `_build/html/` to https://github.com/eclipse/paho-website/tree/master/files/paho.mqtt.python/html
* Announce the release on the Mailing list.
* To allow installing from a git clone, update the version in ``paho/mqtt/__init__.py`` to next number WITH .dev0 (example ``1.2.3.dev0``)
Loading

0 comments on commit 87ce6f6

Please sign in to comment.