Jan Ulrich Hasecke
2019-10-24 939940925a34d1d1bde89143145e17ee5f4b6636
commit | author | age
0a126d 1 # Configuration file for the Sphinx documentation builder.
JUH 2 #
3 # This file only contains a selection of the most common options. For a full
4 # list see the documentation:
5 # https://www.sphinx-doc.org/en/master/usage/configuration.html
6
7 # -- Path setup --------------------------------------------------------------
8
9 # If extensions (or modules to document with autodoc) are in another directory,
10 # add these directories to sys.path here. If the directory is relative to the
11 # documentation root, use os.path.abspath to make it absolute, like shown here.
12 #
13 # import os
14 # import sys
15 # sys.path.insert(0, os.path.abspath('.'))
16
17 import datetime
18 import os
19 import sys
20 from subprocess import check_output
21 import sphinx_rtd_theme
22
939940 23 changesetid = check_output(["git", "rev-parse", "--short", "HEAD"]).decode("utf-8")[:7]
JUH 24
25 numfig = True
26 numfig_secnum_depth = 3
27 math_numfig = False
0a126d 28
JUH 29 # -- Project information -----------------------------------------------------
30
31 project = 'Hostsharing Benutzerhandbuch'
32 copyright = '2019, Hostsharing eG'
33 author = 'Hostsharing eG'
34
35 # The full version, including alpha/beta/rc tags
36 release = '1'
37
38
39 # -- General configuration ---------------------------------------------------
40
41 # Add any Sphinx extension module names here, as strings. They can be
42 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
43 # ones.
44 extensions = [
45 ]
46
47 # Add any paths that contain templates here, relative to this directory.
48 templates_path = ['_templates']
49
50 # The language for content autogenerated by Sphinx. Refer to documentation
51 # for a list of supported languages.
52 #
53 # This is also used if you do content translation via gettext catalogs.
54 # Usually you set "language" from the command line for these cases.
55 language = 'de'
56
57 # List of patterns, relative to source directory, that match files and
58 # directories to ignore when looking for source files.
59 # This pattern also affects html_static_path and html_extra_path.
60 exclude_patterns = []
61
62
63 # -- Options for HTML output -------------------------------------------------
64
65 # The theme to use for HTML and HTML Help pages.  See the documentation for
66 # a list of builtin themes.
67 #
68 html_theme = 'sphinx_rtd_theme'
69
70 # Add any paths that contain custom static files (such as style sheets) here,
71 # relative to this directory. They are copied after the builtin static files,
72 # so a file named "default.css" will overwrite the builtin "default.css".
73 html_static_path = ['_static']
74
75 latex_basename = 'Software-Dokumentation-mit-Sphinx-%s.tex' % changesetid
76
77 latex_engine = 'lualatex'
78
79 latex_elements = {
80     'passoptionstopackages': r'\PassOptionsToPackage{svgnames}{xcolor}',
81     'fontpkg': r'''
939940 82         \setmainfont{TeX Gyre Heros}%
0a126d 83         \setsansfont{TeX Gyre Heros}%
JUH 84 %        \setmonofont[RawFeature=-tlig]{TeX Gyre Cursor}%
85         \setmonofont[Ligatures={NoRequired, NoCommon, NoContextual}]{TeX Gyre Cursor}
86         ''',
939940 87     'preamble': r'\input{./mystyle.sty}',
0a126d 88     'releasename': 'Version',
JUH 89     'fncychap': r'\usepackage[Bjornstrup]{fncychap}',
90     'printindex': r'\footnotesize\raggedright\printindex',
939940 91     'maketitle' : r'\newcommand\sphinxbackoftitlepage{\vspace*{\fill}\noindent Herausgeber: \par Hostsharing eG \par Flughafenstra├če 52a \par 22335 Hamburg}\sphinxmaketitle',
0a126d 92     'sphinxsetup': r'''
JUH 93          verbatimwithframe=false,
94          VerbatimColor={cmyk}{0,0,0,0.1},
95          VerbatimHighlightColor={cmyk}{0,0,0,0},
96          TitleColor={named}{Black},
97          hintBorderColor={named}{Grey},
98          attentionborder=2pt,
99          attentionBorderColor={named}{Grey},
100          attentionBgColor={cmyk}{0,0,0,0.1},
101          noteborder=2pt,
102          noteBorderColor={named}{Grey},
103          cautionborder=2pt,
104          cautionBorderColor={named}{Grey},
105          cautionBgColor={cmyk}{0,0,0,0.1},
106          InnerLinkColor={named}{Black},
107          OuterLinkColor={named}{Black},
108          shadowsize=3pt,
109          verbatimcontinuedalign=l,
110          verbatimcontinuesalign=r
111 ''',
112    'fvset': r'\fvset{fontsize=\footnotesize}',
113 }
114
939940 115 latex_additional_files = ['mystyle.sty']
JUH 116
117 latex_docclass = {'manual': 'book',}
118 latex_show_pagerefs = True
119 latex_show_urls = 'footnote'
120 latex_use_xindy = False
121
0a126d 122 def setup(app):
JUH 123     app.add_object_type('role', 'role',
124     objname='Rolle',
125     indextemplate='pair: %s; Rolle')