- When work has been done on a file:
git add file
orgit add -A
(will add all modified/untracked files) - When work needs to be recorded:
git commit -m "short message"
- To push to the repo:
git push
- To get work from others:
git pull
- In order to activate the virtual environment:
source venv/bin/activate
- To quit the environment: either quit terminal, or type
deactivate
cd docs
make html
produces the html doc in folderbuild/
- The result is in
docs/build/html/index.html
If you want to run doc tests:
cd docs
make doctest
runs all documentation tests
python -m unittest -q tests.example_tests