relay

mirror of https://github.com/chatmail/relay.git synced 2026-06-10 21:51:09 +00:00

Files

T

Jagoda Estera Ślązak 5a31ff475f docs(overview): Remove mermaid styles from 'Accepting and delivering mail' (#1009 )

Previously used colors caused
diagrams to be unreadable in
light mode.
Removing styling completely,
as this was redundant anyway.

Signed-off-by: Jagoda Ślązak <jslazak@jslazak.com>

2026-06-10 22:31:26 +02:00

source

docs(overview): Remove mermaid styles from 'Accepting and delivering mail' (#1009 )

2026-06-10 22:31:26 +02:00

Makefile

Split README into sphinx doc structured sections (#711 )

2025-11-11 14:49:25 +01:00

README.md

docs(doc/README.md): scripts/initenv.sh should be used for building the docs

2026-04-24 21:18:58 +00:00

README.md

Building the documentation

You can use the make command and make html to build web pages.

You need a Python environment with sphinx and other dependencies, you can create it by running scripts/initenv.sh from the repository root.

To develop/change documentation, you can then do:

. venv/bin/activate
cd doc
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.