pipx uses tox for development and continuous integration testing and automation.
pipx first clone the repository, have
tox installed somewhere on your system, then run
Tox creates virtual environments in
.tox/python is the default). Make any changes and then invoke
pipx like this:
Any changes you make to pipx source code will be reflected immediately.
Make sure your changes pass tests by running tox
Documentation is generated with
mkdocs which generates documentation from several
.md files in
docs. Some of those
.md files, as well as the main
README.md file are generated from a
To serve documenation with mkdocs that reflect the content of the
docs folder as you make changes:
tox -e watchdocs
As you serve the docs, if you make changes to any template files, you generate the .md files by running:
tox -e docs
To publish documentation to GitHub pages:
When finished, you may remove the virtual environment with
rm -r .tox.