A good way to work on docs is to use sphinx-autobuild
that will build the docs and start a local Web server that will auto-reload on save.
sphinx-autobuild --watch ledgereth/ docs/ build/docs/
Then you can visit http://127.0.0.1:8000 to view the docs locally.
Make sure to lint your work:
python setup.py lint
- Bump version (
bump2version patch
). This will update the version in source and make a commit and version tag. Don't forget to push your tags:git push --follow-tags
. - Merge branch into
master
- Create GitHub release with tag created by bump2version and release will happen automatically
TIP: Instead of --follow-tags
, you can configure git to always do this on push: git config --global push.followTags true