1#!/usr/bin/env python3
2# -*- coding: utf-8 -*-
3
4import sys
5import os
6import shlex
7
8# -- General configuration ------------------------------------------------
9
10# If your documentation needs a minimal Sphinx version, state it here.
11needs_sphinx = '1.4'
12
13# If true, figures, tables and code-blocks are automatically numbered
14# if they has caption. For now, it works only with the HTML builder.
15# Default is False.
16numfig = True
17
18# Add any Sphinx extension module names here, as strings. They can be
19# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
20# ones.
21extensions = []
22
23locale_dirs = ['@SPHINX_DOCS_DIR@/locales/']
24
25gettext_additional_targets = ['image']
26gettext_location = False
27gettext_compact = True
28
29# Add any paths that contain templates here, relative to this directory.
30#templates_path = ['@SPHINX_DOCS_DIR@/_templates']
31
32# The suffix(es) of source filenames.
33# You can specify multiple suffix as a list of string:
34# source_suffix = ['.rst', '.md']
35source_suffix = '.rst'
36
37# The encoding of source files.
38#source_encoding = 'utf-8-sig'
39
40# The master toctree document.
41master_doc = 'index'
42
43# General information about the project.
44project = 'AusweisApp2 Integration'
45copyright = '2019-2021, Governikus GmbH & Co. KG'
46author = 'Governikus GmbH & Co. KG'
47
48# The version info for the project you're documenting, acts as replacement for
49# |version| and |release|, also used in various other places throughout the
50# built documents.
51#
52# The short X.Y version.
53version = '@PROJECT_VERSION@'
54# The full version, including alpha/beta/rc tags.
55release = '@VERSION_DVCS@'
56
57today = ' '
58
59# The language for content autogenerated by Sphinx. Refer to documentation
60# for a list of supported languages.
61#
62# This is also used if you do content translation via gettext catalogs.
63# Usually you set "language" from the command line for these cases.
64language = 'en'
65
66# List of patterns, relative to source directory, that match files and
67# directories to ignore when looking for source files.
68#exclude_patterns = ['']
69
70
71
72# The name of the Pygments (syntax highlighting) style to use.
73pygments_style = 'sphinx'
74
75
76# The name of an image file (within the static path) to use as favicon of the
77# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
78# pixels large.
79html_favicon = '@SPHINX_DOCS_DIR@/../../resources/images/desktop/npa.ico'
80
81#html_theme_path = ['@SPHINX_DOCS_DIR@/_themes']
82
83#html_theme = 'appcast'
84html_theme = 'sphinx_rtd_theme'
85
86# If false, no module index is generated.
87html_domain_indices = True
88
89# If false, no index is generated.
90html_use_index = True
91
92# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
93html_show_sphinx = False
94
95# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
96html_show_copyright = True
97
98html_scaled_image_link = False
99
100# Output file base name for HTML help builder.
101htmlhelp_basename = 'AusweisApp2Integration'
102
103html_context = {
104    'display_github': False,
105    'display_bitbucket': False,
106    'show_source': False,
107    'html_show_sourcelink': False,
108}
109
110html_add_permalinks = ""
111
112# -- Options for LaTeX output ---------------------------------------------
113
114latex_elements = {
115# The paper size ('letterpaper' or 'a4paper').
116'papersize': 'a4paper',
117
118# The font size ('10pt', '11pt' or '12pt').
119'pointsize': '11pt',
120
121# Additional stuff for the LaTeX preamble.
122'preamble': '''
123\\usepackage{lscape}
124\\hypersetup{pdfauthor={Governikus GmbH \& Co. KG},
125            pdftitle={AusweisApp2},
126            pdfsubject={Integration},
127            pdfkeywords={Integration},
128            pdfproducer={LaTeX},
129            pdfcreator={Sphinx}
130}
131''',
132
133# Override tableofcontents
134'tableofcontents': '''
135\\tableofcontents
136\\newpage
137\\pagestyle{plain}
138\\pagenumbering{arabic}
139''',
140
141# Latex figure (float) alignment
142'figure_align': 'H',
143}
144
145# Grouping the document tree into LaTeX files. List of tuples
146# (source start file, target name, title,
147#  author, documentclass [howto, manual, or own class]).
148latex_documents = [
149  (master_doc, 'AusweisApp2-@VERSION_DVCS@-Integration.tex', 'AusweisApp2 Integration',
150   'Governikus GmbH \& Co. KG', 'howto'),
151]
152
153# The name of an image file (relative to this directory) to place at the top of
154# the title page.
155latex_logo = '@SPHINX_DOCS_DIR@/../../resources/images/npa.png'
156
157# For "manual" documents, if this is true, then toplevel headings are parts,
158# not chapters.
159#latex_use_parts = False
160
161# If true, show page references after internal links.
162latex_show_pagerefs = True
163
164# If true, show URL addresses after external links.
165latex_show_urls = 'footnote'
166
167# Documents to append as an appendix to all manuals.
168#latex_appendices = []
169
170# If false, no module index is generated.
171#latex_domain_indices = True
172