Environment variables

Sphinx Lens itself reads no environment variables: the builder is configured by Sphinx and the CLI by its own flags. The variables below are the ones this repository’s commands, documentation examples, and CI workflows depend on.

PYTHONPATH

Python import search path. In this project docs, it is used for module execution from source (for example PYTHONPATH=src uv run -m ...).

GH_TOKEN

Token consumed by the GitHub CLI (gh) for authenticated API operations. Useful for non-interactive runs such as manual workflow dispatch from CI or scripts.

GITHUB_TOKEN

Ephemeral token automatically injected by GitHub Actions jobs. Used by workflows to interact with repository APIs with job-scoped permissions.

UV_MALWARE_CHECK

Enables uv’s preview lockfile scan against malicious-package advisories from OSV. Make targets and GitHub Actions set it to 1, causing syncs to stop when a locked dependency matches a known malware advisory.

NO_COLOR

De-facto standard variable used by CLI tools to disable ANSI colors. Prefer this for plain-text logs where color escape sequences are undesirable.

FORCE_COLOR

Variable used by many CLIs to force color output even in non-interactive contexts. Use only when colorized logs improve readability and your environment strips correctly.