|
# Configuration file for the Sphinx documentation builder.
|
#
|
# This file only contains a selection of the most common options. For a full
|
# list see the documentation:
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
# -- Path setup --------------------------------------------------------------
|
|
# If extensions (or modules to document with autodoc) are in another directory,
|
# add these directories to sys.path here. If the directory is relative to the
|
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
#
|
# import os
|
# import sys
|
# sys.path.insert(0, os.path.abspath('.'))
|
|
import datetime
|
import os
|
import sys
|
from subprocess import check_output
|
import sphinx_rtd_theme
|
|
changesetid = check_output(["git", "rev-parse", "--short", "HEAD"]).decode("utf-8")[:7]
|
|
numfig = True
|
numfig_secnum_depth = 3
|
math_numfig = False
|
|
# -- Project information -----------------------------------------------------
|
|
project = 'Hostsharing Benutzerhandbuch'
|
copyright = '2019, Hostsharing eG'
|
author = 'Hostsharing eG'
|
|
# The full version, including alpha/beta/rc tags
|
release = '1'
|
|
|
# -- General configuration ---------------------------------------------------
|
|
# Add any Sphinx extension module names here, as strings. They can be
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
# ones.
|
extensions = [
|
'sphinx.ext.todo',
|
'sphinx.ext.graphviz'
|
]
|
|
todo_include_todos = True
|
|
# Add any paths that contain templates here, relative to this directory.
|
templates_path = ['_templates']
|
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
# for a list of supported languages.
|
#
|
# This is also used if you do content translation via gettext catalogs.
|
# Usually you set "language" from the command line for these cases.
|
language = 'de'
|
|
# List of patterns, relative to source directory, that match files and
|
# directories to ignore when looking for source files.
|
# This pattern also affects html_static_path and html_extra_path.
|
exclude_patterns = []
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
# a list of builtin themes.
|
#
|
html_theme = 'sphinx_rtd_theme'
|
|
# Add any paths that contain custom static files (such as style sheets) here,
|
# relative to this directory. They are copied after the builtin static files,
|
# so a file named "default.css" will overwrite the builtin "default.css".
|
html_static_path = ['_static']
|
|
latex_basename = 'Hostsharing-Benutzerhandbuch-%s.tex' % changesetid
|
|
latex_engine = 'lualatex'
|
|
latex_elements = {
|
'passoptionstopackages': r'\PassOptionsToPackage{svgnames}{xcolor}',
|
'fontpkg': r'''
|
\setmainfont{TeX Gyre Heros}%
|
\setsansfont{TeX Gyre Heros}%
|
% \setmonofont[RawFeature=-tlig]{TeX Gyre Cursor}%
|
% \setmonofont[Ligatures={NoRequired, NoCommon, NoContextual}]{TeX Gyre Cursor}
|
\setmonofont{Courier New}[Scale=MatchLowercase,ScaleAgain=0.9]
|
''',
|
'preamble': r'\input{./mystyle.sty}',
|
'releasename': 'Version',
|
'fncychap': r'\usepackage[Bjornstrup]{fncychap}',
|
'printindex': r'\footnotesize\raggedright\printindex',
|
'maketitle' : r'\newcommand\sphinxbackoftitlepage{\vspace*{\fill}\noindent Herausgeber: \par Hostsharing eG \par Flughafenstraße 52a \par 22335 Hamburg}\sphinxmaketitle',
|
'sphinxsetup': r'''
|
verbatimwithframe=false,
|
VerbatimColor={cmyk}{0,0,0,0.1},
|
VerbatimHighlightColor={cmyk}{0,0,0,0},
|
TitleColor={named}{Black},
|
hintBorderColor={named}{Grey},
|
attentionborder=2pt,
|
attentionBorderColor={named}{Grey},
|
attentionBgColor={cmyk}{0,0,0,0.1},
|
noteborder=2pt,
|
noteBorderColor={named}{Grey},
|
cautionborder=2pt,
|
cautionBorderColor={named}{Grey},
|
cautionBgColor={cmyk}{0,0,0,0.1},
|
InnerLinkColor={named}{Black},
|
OuterLinkColor={named}{Black},
|
shadowsize=3pt,
|
verbatimcontinuedalign=l,
|
verbatimcontinuesalign=r
|
''',
|
'fvset': r'\fvset{fontsize=\footnotesize}',
|
}
|
|
latex_additional_files = ['mystyle.sty']
|
|
latex_docclass = {'manual': 'book',}
|
latex_show_pagerefs = True
|
latex_show_urls = 'footnote'
|
latex_use_xindy = False
|
|
latex_documents = [
|
('index', latex_basename, 'Hostsharing Benutzerhandbuch',
|
'Hostsharing eG', 'manual'),
|
]
|
|
def setup(app):
|
app.add_object_type('role', 'role',
|
objname='Rolle',
|
indextemplate='pair: %s; Rolle')
|
