emanuel@903: # -*- coding: utf-8 -*-
emanuel@903: #
emanuel@903: # Dokumentationsvorlage documentation build configuration file, created by
emanuel@903: # sphinx-quickstart on Fri Dec 14 12:07:59 2012.
emanuel@903: #
emanuel@903: # This file is execfile()d with the current directory set to its containing dir.
emanuel@903: #
emanuel@903: # Note that not all possible configuration values are present in this
emanuel@903: # autogenerated file.
emanuel@903: #
emanuel@903: # All configuration values have a default; values that are commented out
emanuel@903: # serve to show the default.
emanuel@903: 
emanuel@903: import sys, os
emanuel@903: 
emanuel@903: # If extensions (or modules to document with autodoc) are in another directory,
emanuel@903: # add these directories to sys.path here. If the directory is relative to the
emanuel@903: # documentation root, use os.path.abspath to make it absolute, like shown here.
emanuel@903: #sys.path.insert(0, os.path.abspath('extensions'))
emanuel@903: 
emanuel@903: # -- General configuration -----------------------------------------------------
emanuel@903: 
emanuel@903: # If your documentation needs a minimal Sphinx version, state it here.
emanuel@903: #needs_sphinx = '1.0'
emanuel@903: 
emanuel@903: # Add any Sphinx extension module names here, as strings. They can be extensions
emanuel@903: # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
emanuel@903: #extensions = ['']
emanuel@903: 
emanuel@903: # Add any paths that contain templates here, relative to this directory.
andre@1322: templates_path = ['@HELP_MANUAL_IN@/../_templates']
emanuel@903: 
emanuel@903: # The suffix of source filenames.
emanuel@903: source_suffix = '.rst'
emanuel@903: 
emanuel@903: # The encoding of source files.
emanuel@903: #source_encoding = 'utf-8-sig'
emanuel@903: 
emanuel@903: # The master toctree document.
emanuel@903: master_doc = 'index'
emanuel@903: 
emanuel@903: # General information about the project.
emanuel@903: project = u'TrustBridge-Hilfe'
emanuel@1238: #copyright = u''
emanuel@903: 
emanuel@903: # The version info for the project you're documenting, acts as replacement for
emanuel@903: # |version| and |release|, also used in various other places throughout the
emanuel@903: # built documents.
emanuel@903: #
emanuel@903: # The short X.Y version.
andre@933: version = '@HG_REVISION_TAG@'
emanuel@903: # The full version, including alpha/beta/rc tags.
andre@933: release = '@PROJECT_VERSION@'
emanuel@903: 
emanuel@903: # The language for content autogenerated by Sphinx. Refer to documentation
emanuel@903: # for a list of supported languages.
emanuel@903: language = 'de'
emanuel@903: 
emanuel@903: # There are two options for replacing |today|: either, you set today to some
emanuel@903: # non-false value, then it is used:
emanuel@903: #today = ''
emanuel@903: # Else, today_fmt is used as the format for a strftime call.
emanuel@903: #today_fmt = '%B %d, %Y'
emanuel@903: 
emanuel@903: # List of patterns, relative to source directory, that match files and
emanuel@903: # directories to ignore when looking for source files.
emanuel@903: exclude_patterns = ['_build']
emanuel@903: 
emanuel@903: # The reST default role (used for this markup: `text`) to use for all documents.
emanuel@903: #default_role = None
emanuel@903: 
emanuel@903: # If true, '()' will be appended to :func: etc. cross-reference text.
emanuel@903: #add_function_parentheses = True
emanuel@903: 
emanuel@903: # If true, the current module name will be prepended to all description
emanuel@903: # unit titles (such as .. function::).
emanuel@903: #add_module_names = True
emanuel@903: 
emanuel@903: # If true, sectionauthor and moduleauthor directives will be shown in the
emanuel@903: # output. They are ignored by default.
emanuel@903: #show_authors = False
emanuel@903: 
emanuel@903: # The name of the Pygments (syntax highlighting) style to use.
emanuel@903: pygments_style = 'sphinx'
emanuel@903: 
emanuel@903: # A list of ignored prefixes for module index sorting.
emanuel@903: #modindex_common_prefix = []
emanuel@903: 
emanuel@903: 
emanuel@903: # -- Options for HTML output ---------------------------------------------------
emanuel@903: 
emanuel@903: # The theme to use for HTML and HTML Help pages.  See the documentation for
emanuel@903: # a list of builtin themes.
andre@933: html_theme_path = ['@SPHINX_THEME_DIR@']
andre@933: html_theme = '@SPHINX_THEME@'
emanuel@903: 
emanuel@903: # Theme options are theme-specific and customize the look and feel of a theme
emanuel@903: # further.  For a list of options available for each theme, see the
emanuel@903: # documentation.
emanuel@903: html_theme_options = {
emanuel@903:     'linktotheme': False,
andre@1320:     'cssfiles': ['_static/extra-style.css'],
emanuel@903: }
emanuel@903: 
emanuel@903: # Add any paths that contain custom themes here, relative to this directory.
emanuel@903: #html_theme_path = []
emanuel@903: 
emanuel@903: # The name for this set of Sphinx documents.  If None, it defaults to
emanuel@903: # "<project> v<release> documentation".
emanuel@903: html_title = 'TrustBridge-Hilfe'
emanuel@903: 
emanuel@903: # A shorter title for the navigation bar.  Default is the same as html_title.
emanuel@903: html_short_title = 'Home'
emanuel@903: 
emanuel@903: # The name of an image file (relative to this directory) to place at the top
emanuel@903: # of the sidebar.
emanuel@903: #html_logo = None
emanuel@903: 
emanuel@903: # The name of an image file (within the static path) to use as favicon of the
emanuel@903: # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
emanuel@903: # pixels large.
emanuel@903: #html_favicon = None
emanuel@903: 
emanuel@903: # Add any paths that contain custom static files (such as style sheets) here,
emanuel@903: # relative to this directory. They are copied after the builtin static files,
emanuel@903: # so a file named "default.css" will overwrite the builtin "default.css".
andre@936: html_static_path = ['@HELP_MANUAL_IN@/_static']
emanuel@903: 
emanuel@903: # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
emanuel@903: # using the given strftime format.
emanuel@903: #html_last_updated_fmt = '%b %d, %Y'
emanuel@903: 
emanuel@903: # If true, SmartyPants will be used to convert quotes and dashes to
emanuel@903: # typographically correct entities.
emanuel@903: #html_use_smartypants = True
emanuel@903: 
emanuel@903: # Custom sidebar templates, maps document names to template names.
emanuel@903: html_sidebars = {
emanuel@903:     '**': ['globaltoc.html', 'searchbox.html'],
emanuel@903: }
emanuel@903: 
emanuel@903: # Additional templates that should be rendered to pages, maps page names to
emanuel@903: # template names.
emanuel@903: #html_additional_pages = {}
emanuel@903: 
emanuel@903: # If false, no module index is generated.
emanuel@903: #html_domain_indices = True
emanuel@903: 
emanuel@903: # If false, no index is generated.
emanuel@903: #html_use_index = True
emanuel@903: 
emanuel@903: # If true, the index is split into individual pages for each letter.
emanuel@903: #html_split_index = False
emanuel@903: 
emanuel@903: # If true, links to the reST sources are added to the pages.
emanuel@903: #html_show_sourcelink = True
emanuel@903: 
emanuel@903: # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
emanuel@903: html_show_sphinx = False
emanuel@903: 
emanuel@903: # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
emanuel@903: #html_show_copyright = True
emanuel@903: 
emanuel@903: # If true, an OpenSearch description file will be output, and all pages will
emanuel@903: # contain a <link> tag referring to it.  The value of this option must be the
emanuel@903: # base URL from which the finished HTML is served.
emanuel@903: #html_use_opensearch = ''
emanuel@903: 
emanuel@903: # This is the file name suffix for HTML files (e.g. ".xhtml").
emanuel@903: #html_file_suffix = None
emanuel@903: 
emanuel@903: # Output file base name for HTML help builder.
emanuel@903: # htmlhelp_basename = ''
emanuel@903: 
emanuel@903: 
emanuel@903: # -- Options for LaTeX output --------------------------------------------------
emanuel@903: 
emanuel@903: latex_elements = {
emanuel@903: # The paper size ('letterpaper' or 'a4paper').
emanuel@903: 'papersize': 'a4paper,oneside',
emanuel@903: 
emanuel@903: # The font size ('10pt', '11pt' or '12pt').
emanuel@903: 'pointsize': '11pt',
emanuel@903: 
emanuel@903: # Additional stuff for the LaTeX preamble.
emanuel@903: 'preamble': 
emanuel@903:    '\\usepackage{colortbl} '\
emanuel@903:    '\\usepackage{booktabs} '\
emanuel@903:    '\\usepackage{tabularx} '\
emanuel@903:    '\\newcommand{\\projecttitle}{} '\
emanuel@903:    '\\newcommand{\\documenttype}{TrustBridge-Benutzerdokumentation} '\
emanuel@903:    '\\newcommand{\\documentdate}{12. August 2014} '\
emanuel@903:    '\\newcommand{\\documentversion}{Version 0.1} '\
emanuel@903:    '\\newcommand{\\customer}{BSI} '\
emanuel@903:    '',
emanuel@903: 
emanuel@903: 'babel': '\usepackage[ngerman]{babel}',
emanuel@903: 'fncychap' : '',
emanuel@903: 
emanuel@903: 'maketitle': 
emanuel@903:   # Titelseite
emanuel@903:   '\\includegraphics[height=2cm]{brieflogo-neu.png} \\\\[2.5cm] '\
emanuel@903:   '{\\sffamily\\bfseries\\large \\projecttitle \\\\[0.5cm] '\
emanuel@903:   '\\huge \\documenttype \\\\[2.5cm]'\
emanuel@903:   '\\small \\documentdate, \\documentversion \\\\[2.5cm]'\
emanuel@903:   '\\sffamily\\bfseries\\small '\
emanuel@903:   'Autor: Intevation GmbH\\\\[1.0cm] '\
emanuel@903:   '} '\
emanuel@903:   '',
emanuel@903: }
emanuel@903: 
emanuel@903: # Grouping the document tree into LaTeX files. List of tuples
emanuel@903: # (source start file, target name, title, author, documentclass [howto/manual]).
emanuel@903: latex_documents = [
emanuel@903:   ('index', 'TrustBridge-Hilfe.tex', u'TrustBridge-Hilfe',
emanuel@903:    u'Intevation GmbH', 'manual'),
emanuel@903: ]
emanuel@903: 
emanuel@903: latex_docclass = { 'manual': 'scrreprt', }
emanuel@903: 
emanuel@903: # The name of an image file (relative to this directory) to place at the top of
emanuel@903: # the title page.
emanuel@903: #latex_logo = None
emanuel@903: 
emanuel@903: # For "manual" documents, if this is true, then toplevel headings are parts,
emanuel@903: # not chapters.
emanuel@903: latex_use_parts = False
emanuel@903: 
emanuel@903: # If true, show page references after internal links.
emanuel@903: #latex_show_pagerefs = False
emanuel@903: 
emanuel@903: # If true, show URL addresses after external links.
emanuel@903: #latex_show_urls = False
emanuel@903: 
emanuel@903: # Documents to append as an appendix to all manuals.
emanuel@903: #latex_appendices = []
emanuel@903: 
emanuel@903: # If false, no module index is generated.
emanuel@903: #latex_domain_indices = True