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