1
0
mirror of https://blitiri.com.ar/repos/chasquid synced 2026-01-08 17:51:57 +00:00

docs: Integrate with readthedocs.org

This patch adds configuration to integrate with readthedocs.org, using
mkdocs as rendering engine.

It also does minor documentation updates, to tidy some things up
(clearer titles, move some documentation from the root into docs/, etc).
This commit is contained in:
Alberto Bertogli
2019-08-05 14:14:55 +01:00
parent 0d3bbe11c0
commit d348477841
9 changed files with 98 additions and 5 deletions

29
docs/man/index.md Normal file
View File

@@ -0,0 +1,29 @@
# Manual pages
From the latest Debian package:
- [chasquid(1)](https://manpages.debian.org/unstable/chasquid/chasquid.1):
the main binary.
- [chasquid.conf(5)](https://manpages.debian.org/unstable/chasquid/chasquid.conf.5):
the configuration file and structure.
- [chasquid-util(1)](https://manpages.debian.org/unstable/chasquid/chasquid-util.1):
the command-line utility helper.
- [mda-lmtp(1)](https://manpages.debian.org/unstable/chasquid/mda-lmtp.1):
helper to integrate with LMTP delivery.
- [smtp-check(1)](https://manpages.debian.org/unstable/chasquid/smtp-check.1):
SMTP setup checker.
From the development branch (more likely to change, but useful when doing
development or running experimental versions):
- [chasquid(1)](https://github.com/albertito/chasquid/blob/next/docs/man/chasquid.1.pod):
the main binary.
- [chasquid.conf(5)](https://github.com/albertito/chasquid/blob/next/docs/man/chasquid.conf.5.pod):
the configuration file and structure.
- [chasquid-util(1)](https://github.com/albertito/chasquid/blob/next/docs/man/chasquid-util.1.pod):
the command-line utility helper.
- [mda-lmtp(1)](https://github.com/albertito/chasquid/blob/next/docs/man/mda-lmtp.1.pod):
helper to integrate with LMTP delivery.
- [smtp-check(1)](https://github.com/albertito/chasquid/blob/next/docs/man/smtp-check.1.pod):
SMTP setup checker.