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