Contributing¶
Clone:
$ git clone https://github.com/git-pull/gp-libs.git
$ cd gp-libs
Install packages:
$ uv sync --all-extras --dev
Tests¶
$ uv run py.test
Automatically run tests on file save¶
make start(via pytest-watcher)make watch_test(requires installing entr(1))
Documentation¶
Default preview server: http://localhost:8034
sphinx-autobuild will automatically build the docs, watch for file changes and launch a server.
From home directory: make start_docs
From inside docs/: make start
Manual documentation (the hard way)¶
cd docs/ and make html to build. make serve to start http server.
Helpers:
make build_docs, make serve_docs
Rebuild docs on file change: make watch_docs (requires entr(1))
Rebuild docs and run server via one terminal: make dev_docs (requires above, and a
make(1) with -J support, e.g. GNU Make)