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>
42 lines
1.2 KiB
Python
42 lines
1.2 KiB
Python
# Configuration file for the Sphinx documentation builder.
|
|
#
|
|
# For the full list of built-in configuration values, see the documentation:
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
|
|
|
project = 'chatmail relay documentation'
|
|
copyright = '2025, chatmail collective'
|
|
author = 'chatmail collective'
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
|
|
|
extensions = [
|
|
#'sphinx.ext.autodoc',
|
|
#'sphinx.ext.viewdoc',
|
|
'sphinxcontrib.mermaid',
|
|
]
|
|
|
|
templates_path = ['_templates']
|
|
exclude_patterns = []
|
|
|
|
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
|
|
|
|
html_theme = 'furo'
|
|
html_static_path = ['_static']
|
|
html_css_files = [
|
|
"custom.css",
|
|
]
|
|
|
|
html_title = "chatmail relay documentation"
|
|
#html_short_title = f"chatmail-{release}"
|
|
|
|
html_logo = "_static/chatmail.svg"
|
|
|
|
|