Jan Ulrich Hasecke
2019-11-04 786c9fdad173154b8ad878ae8e3038a33377b5ed
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 = [
786c9f 45     'sphinx.ext.todo',
JUH 46     'sphinx.ext.graphviz'
0a126d 47 ]
786c9f 48
JUH 49 todo_include_todos = True 
0a126d 50
JUH 51 # Add any paths that contain templates here, relative to this directory.
52 templates_path = ['_templates']
53
54 # The language for content autogenerated by Sphinx. Refer to documentation
55 # for a list of supported languages.
56 #
57 # This is also used if you do content translation via gettext catalogs.
58 # Usually you set "language" from the command line for these cases.
59 language = 'de'
60
61 # List of patterns, relative to source directory, that match files and
62 # directories to ignore when looking for source files.
63 # This pattern also affects html_static_path and html_extra_path.
64 exclude_patterns = []
65
66
67 # -- Options for HTML output -------------------------------------------------
68
69 # The theme to use for HTML and HTML Help pages.  See the documentation for
70 # a list of builtin themes.
71 #
72 html_theme = 'sphinx_rtd_theme'
73
74 # Add any paths that contain custom static files (such as style sheets) here,
75 # relative to this directory. They are copied after the builtin static files,
76 # so a file named "default.css" will overwrite the builtin "default.css".
77 html_static_path = ['_static']
78
786c9f 79 latex_basename = 'Hostsharing-Benutzerhandbuch-%s.tex' % changesetid
0a126d 80
JUH 81 latex_engine = 'lualatex'
82
83 latex_elements = {
84     'passoptionstopackages': r'\PassOptionsToPackage{svgnames}{xcolor}',
85     'fontpkg': r'''
939940 86         \setmainfont{TeX Gyre Heros}%
0a126d 87         \setsansfont{TeX Gyre Heros}%
JUH 88 %        \setmonofont[RawFeature=-tlig]{TeX Gyre Cursor}%
ad994f 89 %        \setmonofont[Ligatures={NoRequired, NoCommon, NoContextual}]{TeX Gyre Cursor}
JUH 90         \setmonofont{Courier New}[Scale=MatchLowercase,ScaleAgain=0.9]
0a126d 91         ''',
939940 92     'preamble': r'\input{./mystyle.sty}',
0a126d 93     'releasename': 'Version',
JUH 94     'fncychap': r'\usepackage[Bjornstrup]{fncychap}',
95     'printindex': r'\footnotesize\raggedright\printindex',
939940 96     'maketitle' : r'\newcommand\sphinxbackoftitlepage{\vspace*{\fill}\noindent Herausgeber: \par Hostsharing eG \par Flughafenstra├če 52a \par 22335 Hamburg}\sphinxmaketitle',
0a126d 97     'sphinxsetup': r'''
JUH 98          verbatimwithframe=false,
99          VerbatimColor={cmyk}{0,0,0,0.1},
100          VerbatimHighlightColor={cmyk}{0,0,0,0},
101          TitleColor={named}{Black},
102          hintBorderColor={named}{Grey},
103          attentionborder=2pt,
104          attentionBorderColor={named}{Grey},
105          attentionBgColor={cmyk}{0,0,0,0.1},
106          noteborder=2pt,
107          noteBorderColor={named}{Grey},
108          cautionborder=2pt,
109          cautionBorderColor={named}{Grey},
110          cautionBgColor={cmyk}{0,0,0,0.1},
111          InnerLinkColor={named}{Black},
112          OuterLinkColor={named}{Black},
113          shadowsize=3pt,
114          verbatimcontinuedalign=l,
115          verbatimcontinuesalign=r
116 ''',
117    'fvset': r'\fvset{fontsize=\footnotesize}',
118 }
119
939940 120 latex_additional_files = ['mystyle.sty']
JUH 121
122 latex_docclass = {'manual': 'book',}
123 latex_show_pagerefs = True
124 latex_show_urls = 'footnote'
125 latex_use_xindy = False
126
786c9f 127 latex_documents = [
JUH 128     ('index', latex_basename, 'Hostsharing Benutzerhandbuch',
129      'Hostsharing eG', 'manual'),
130     ]
131
0a126d 132 def setup(app):
JUH 133     app.add_object_type('role', 'role',
134     objname='Rolle',
135     indextemplate='pair: %s; Rolle')