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.3'
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 = 'appcast'
42
43# General information about the project.
44project = 'AusweisApp2'
45copyright = '2016-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
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.
62language = 'de'
63
64# List of patterns, relative to source directory, that match files and
65# directories to ignore when looking for source files.
66exclude_patterns = ['index.rst', 'support.rst', 'versions.rst', 'general.rst']
67
68
69
70# The name of the Pygments (syntax highlighting) style to use.
71pygments_style = 'sphinx'
72
73
74# The name of an image file (within the static path) to use as favicon of the
75# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
76# pixels large.
77html_favicon = '@SPHINX_DOCS_DIR@/../../resources/images/desktop/npa.ico'
78
79html_theme_path = ['@SPHINX_DOCS_DIR@/_themes']
80
81html_theme = 'appcast'
82
83# If false, no module index is generated.
84html_domain_indices = True
85
86# If false, no index is generated.
87html_use_index = True
88
89# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
90html_show_sphinx = False
91
92# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
93html_show_copyright = True
94
95html_scaled_image_link = False
96
97# Output file base name for HTML help builder.
98htmlhelp_basename = 'AusweisApp2ReleaseNotes'
99
100html_context = {
101    'display_github': False,
102    'display_bitbucket': False,
103    'show_source': False,
104    'html_show_sourcelink': False,
105}
106
107html_add_permalinks = ""
108
109