diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 288f021..97dbb61 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,6 +9,15 @@ tox devenv -e integration source venv/bin/activate ``` +## Generating src docs for every commit + +Run the following command: + +```bash +echo -e "tox -e src-docs\ngit add src-docs\n" >> .git/hooks/pre-commit +chmod +x .git/hooks/pre-commit +``` + ## Testing This project uses `tox` for managing test environments. There are some pre-configured environments