akvo / akvo-mis / #746

89%

push

coveralls-python

Refresh user documentation and re-capture screenshots with Akvo MIS branding (#263)

* Add a uv project so the docs build without a manual Python setup

Developers can now build the Sphinx documentation with a single
`uv run make html` from the `docs/` directory; uv provisions the
interpreter, virtualenv, and pinned dependencies automatically. A
`docs/README.md` documents this alongside the pre-existing Docker
`generate.sh` and manual pip build paths.

The Python version is pinned to 3.10 rather than something newer
because the theme is pinned to `sphinx-rtd-theme==1.0.0` (matching
`requirements.txt` and the deployed ReadTheDocs theme), which drags in
docutils 0.17 and Sphinx 5.x — neither of which installs on current
Python. 3.10 is the newest interpreter the whole pin set resolves
against.

`uv.lock` is committed so every developer builds from the identical
package set. The existing `requirements.txt` and the Docker-based
`generate.sh` are left untouched as alternative build paths.

* Add sphinx-autobuild as a dev dependency for live docs preview

Adds `sphinx-autobuild` to a `dev` dependency group so
`uv run sphinx-autobuild source build/html` gives a live-reload preview
while editing docs, and documents it in the docs README. The tool is
dev-only and does not affect the published build.

The documented example uses `--port 8899` because every port the tool
would otherwise pick is taken by the Docker Compose dev stack, which
binds 3000, 5050, 5432, 8000, and 8888 on the host.

* Configure Expo for LAN device access and offline Expo Go dev

Add two environment variables to the mobile dev container:

    REACT_NATIVE_PACKAGER_HOSTNAME=${EXPO_HOST}
    EXPO_OFFLINE=1

Expo runs inside the container but is reached from a physical device on
the LAN, so Metro must advertise the host's LAN IP rather than the
container-internal 127.0.0.1.

The app configures EAS Update, so `expo start` would otherwise serve a
signed update manifest that needs an Expo accou... (continued)

5686 of 6594 branches covered (86.23%)

Branch coverage included in aggregate %.

10696 of 11925 relevant lines covered (89.69%)

0.9 hits per line