singlehtml.conf.py.in

#!/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.3'

# 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 = 'appcast'

# General information about the project.
project = 'AusweisApp2'
copyright = '2016-2021, 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 = 'de'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['index.rst', 'support.rst', 'versions.rst', 'general.rst']



# 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'

# 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 = 'AusweisApp2ReleaseNotes'

html_context = {
    'display_github': False,
    'display_bitbucket': False,
    'show_source': False,
    'html_show_sourcelink': False,
}

html_add_permalinks = ""