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