mirror of
https://github.com/chatmail/relay.git
synced 2026-05-10 16:04:37 +00:00
50b986a265
refactor README.rst and architecture file into sphinx doc project, automatically deploying on main merges and PRs. * add FAQs from https://chatmail.at/relays landing page * fix links, and streamline postfix/dovecot mentioning * add linkcheck to CI, fix several links and streamlihne DKIM section while at it * some streamlining, rename to "overview" * ci: upload documentation to chatmail.at/doc/relay * ci: main should be uploaded when docs.yaml changes * ci: fix typo * Update .github/workflows/docs-preview.yaml Co-authored-by: missytake <missytake@systemli.org>
18 lines
419 B
Markdown
18 lines
419 B
Markdown
|
|
|
|
## 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 sphinx-build 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.
|
|
|