mirror of
https://github.com/chatmail/relay.git
synced 2026-05-10 07:54:36 +00:00
0808c9dc47
Docker and Compose support is provided through a standalone repo at https://github.com/chatmail/docker, add reusable Docker build/test CI jobs to staging workflows and a Docker docs stub pointing to the chatmail/docker repository. Requires CHATMAIL_DOCKER_DISPATCH_TOKEN secret in relay repo settings (fine-grained PAT with contents:write on chatmail/docker).
Building the documentation
You can use the make command and make html to build web pages.
You need a Python environment where the following install was excuted:
pip install furo sphinx-autobuild
To develop/change documentation, you can then do:
make auto
A page will open at https://127.0.0.1:8000/ serving the docs and it will react to changes to source files pretty fast.