1
0
mirror of https://github.com/Mailu/Mailu.git synced 2024-12-12 10:45:38 +02:00
Mailu/docs/conf.py

49 lines
1.2 KiB
Python
Raw Normal View History

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
extensions = ['sphinx.ext.imgmath', 'sphinx.ext.viewcode', 'sphinx_rtd_theme']
templates_path = ['_templates']
source_suffix = '.rst'
2017-11-01 13:37:32 +02:00
master_doc = 'index'
project = 'Mailu'
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 = {
'**': [
'relations.html',
2017-11-01 13:37:32 +02:00
'searchbox.html',
]
}
# Theme options
html_context = {
'display_github': True,
'github_user': 'mailu',
'github_repo': 'mailu',
2018-10-16 22:55:05 +02:00
'github_version': version,
'stable_version': '1.8',
2018-10-16 22:52:21 +02:00
'versions': [
('1.5', '/1.5/'),
('1.6', '/1.6/'),
('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/')
],
'conf_py_path': '/docs/'
}