Contributing¶
Clone:
$ git clone https://github.com/git-pull/gp-libs.git
$ cd gp-libs
Install packages:
$ uv sync --all-extras --dev
Tests¶
$ just test
Automatically run tests on file save¶
Use pytest-watcher:
$ just start
Use entr(1) when you want a shell-only watcher:
$ just watch-test
Documentation¶
Build the docs:
$ just build-docs
Start the default preview server:
$ just start-docs
sphinx-autobuild builds the docs, watches for file changes, and launches the preview server.
From inside docs/, run the local docs justfile directly:
$ just start
Manual documentation¶
Build from inside docs/:
$ just html
Serve the built HTML:
$ just serve
Watch and rebuild on file changes:
$ just watch
Watch and serve in one terminal:
$ just dev