2017-11-01 13:37:32 +02:00
|
|
|
#!/usr/bin/env python3
|
|
|
|
# -*- coding: utf-8 -*-
|
|
|
|
#
|
|
|
|
|
2018-10-16 22:52:21 +02:00
|
|
|
import os
|
|
|
|
|
2021-07-21 12:18:14 +02:00
|
|
|
extensions = ['sphinx.ext.imgmath', 'sphinx.ext.viewcode', 'sphinx_rtd_theme']
|
2017-11-04 22:38:29 +02:00
|
|
|
templates_path = ['_templates']
|
2017-11-02 21:05:12 +02:00
|
|
|
source_suffix = '.rst'
|
2017-11-01 13:37:32 +02:00
|
|
|
master_doc = 'index'
|
|
|
|
project = 'Mailu'
|
2018-09-28 10:41:17 +02:00
|
|
|
copyright = '2018, Mailu authors'
|
2017-11-01 13:37:32 +02:00
|
|
|
author = 'Mailu authors'
|
2018-10-16 22:55:05 +02:00
|
|
|
version = release = os.environ.get('VERSION', 'master')
|
2017-11-01 13:37:32 +02:00
|
|
|
language = None
|
2018-10-16 22:55:05 +02:00
|
|
|
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'Dockerfile', 'docker-compose.yml']
|
2017-11-01 13:37:32 +02:00
|
|
|
pygments_style = 'sphinx'
|
|
|
|
todo_include_todos = False
|
2017-11-01 21:12:17 +02:00
|
|
|
html_theme = 'sphinx_rtd_theme'
|
2017-11-21 23:34:49 +02:00
|
|
|
html_title = 'Mailu, Docker based mail server'
|
2017-11-04 20:07:55 +02:00
|
|
|
html_static_path = []
|
2017-11-04 20:28:19 +02:00
|
|
|
htmlhelp_basename = 'Mailudoc'
|
2017-11-01 13:37:32 +02:00
|
|
|
|
|
|
|
# Custom sidebar templates, must be a dictionary that maps document names
|
|
|
|
# to template names.
|
|
|
|
html_sidebars = {
|
|
|
|
'**': [
|
2018-09-28 10:41:17 +02:00
|
|
|
'relations.html',
|
2017-11-01 13:37:32 +02:00
|
|
|
'searchbox.html',
|
|
|
|
]
|
|
|
|
}
|
2017-11-04 22:38:29 +02:00
|
|
|
|
|
|
|
# Theme options
|
|
|
|
html_context = {
|
|
|
|
'display_github': True,
|
|
|
|
'github_user': 'mailu',
|
|
|
|
'github_repo': 'mailu',
|
2018-10-16 22:55:05 +02:00
|
|
|
'github_version': version,
|
2020-10-04 15:22:59 +02:00
|
|
|
'stable_version': '1.7',
|
2018-10-16 22:52:21 +02:00
|
|
|
'versions': [
|
|
|
|
('1.5', '/1.5/'),
|
2019-01-18 21:53:38 +02:00
|
|
|
('1.6', '/1.6/'),
|
2019-08-21 13:27:39 +02:00
|
|
|
('1.7', '/1.7/'),
|
2020-10-01 20:32:05 +02:00
|
|
|
('1.8', '/1.8/'),
|
2018-10-16 22:52:21 +02:00
|
|
|
('master', '/master/')
|
|
|
|
],
|
2017-11-04 22:38:29 +02:00
|
|
|
'conf_py_path': '/docs/'
|
|
|
|
}
|