mxd2map/mxd2map: doku/source/conf.py annotate

annotate doku/source/conf.py @ 188:43f1cbdcd597

Modified and beautified the documentation: * INSTALL.txt, doku/Makefile, doku/source/conf.py, doku/source/functionality.txt, doku/source/index.txt, doku/source/restrictions.txt, website/favicon.png, LICENCE.txt: added more details to the content of the documentation. some more configurations. * doku/source/LICENCE.txt: New. Added a licence-text (symlinking into the documentation). * doku/source/_static/favicon.png, doku/source/_static/logo_wide.png, doku/source/_templates/indexsidebar.html, doku/source/_templates/layout.html: Optic-cosmetics.

author	Stephan Holl <stephan.holl@intevation.de>
date	Wed, 20 Jul 2011 15:53:01 +0200
parents	0ebaec057f15
children	1e3a5019c4ed

rev	line source
139 2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	1 # -- coding: utf-8 --
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	2 #
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	3 # MXD2map documentation build configuration file, created by
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	4 # sphinx-quickstart on Mon Jun 20 09:48:05 2011.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	5 #
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	6 # This file is execfile()d with the current directory set to its containing dir.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	7 #
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	8 # Note that not all possible configuration values are present in this
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	9 # autogenerated file.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	10 #
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	11 # All configuration values have a default; values that are commented out
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	12 # serve to show the default.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	13
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	14 import sys, os
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	15
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	16 # If extensions (or modules to document with autodoc) are in another directory,
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	17 # add these directories to sys.path here. If the directory is relative to the
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	18 # documentation root, use os.path.abspath to make it absolute, like shown here.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	19 #sys.path.insert(0, os.path.abspath('.'))
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	20
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	21 # -- General configuration -----------------------------------------------------
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	22
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	23 # If your documentation needs a minimal Sphinx version, state it here.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	24 #needs_sphinx = '1.0'
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	25
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	26 # Add any Sphinx extension module names here, as strings. They can be extensions
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	27 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	28 extensions = ['sphinx.ext.viewcode']
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	29
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	30 # Add any paths that contain templates here, relative to this directory.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	31 templates_path = ['_templates']
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	32
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	33 # The suffix of source filenames.
140 0ebaec057f15 * INSTALL.txt: added a hint how to install the converter and its Stephan Holl <stephan.holl@intevation.de> parents: 139 diff changeset	34 source_suffix = '.txt'
139 2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	35
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	36 # The encoding of source files.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	37 #source_encoding = 'utf-8-sig'
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	38
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	39 # The master toctree document.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	40 master_doc = 'index'
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	41
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	42 # General information about the project.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	43 project = u'MXD2map'
188 43f1cbdcd597 Modified and beautified the documentation: Stephan Holl <stephan.holl@intevation.de> parents: 140 diff changeset	44 copyright = u'2011, Bundesamt fuer Seeschifffahrt und Hydrographie,
43f1cbdcd597 Modified and beautified the documentation: Stephan Holl <stephan.holl@intevation.de> parents: 140 diff changeset	45 Intevation GmbH'
139 2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	46
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	47 # The version info for the project you're documenting, acts as replacement for
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	48 # \|version\| and \|release\|, also used in various other places throughout the
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	49 # built documents.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	50 #
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	51 # The short X.Y version.
188 43f1cbdcd597 Modified and beautified the documentation: Stephan Holl <stephan.holl@intevation.de> parents: 140 diff changeset	52 version = '0.1'
139 2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	53 # The full version, including alpha/beta/rc tags.
188 43f1cbdcd597 Modified and beautified the documentation: Stephan Holl <stephan.holl@intevation.de> parents: 140 diff changeset	54 release = '0.1'
139 2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	55
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	56 # The language for content autogenerated by Sphinx. Refer to documentation
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	57 # for a list of supported languages.
188 43f1cbdcd597 Modified and beautified the documentation: Stephan Holl <stephan.holl@intevation.de> parents: 140 diff changeset	58 language = 'en'
139 2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	59
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	60 # There are two options for replacing \|today\|: either, you set today to some
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	61 # non-false value, then it is used:
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	62 #today = ''
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	63 # Else, today_fmt is used as the format for a strftime call.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	64 #today_fmt = '%B %d, %Y'
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	65
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	66 # List of patterns, relative to source directory, that match files and
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	67 # directories to ignore when looking for source files.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	68 exclude_patterns = []
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	69
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	70 # The reST default role (used for this markup: `text`) to use for all documents.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	71 #default_role = None
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	72
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	73 # If true, '()' will be appended to :func: etc. cross-reference text.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	74 #add_function_parentheses = True
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	75
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	76 # If true, the current module name will be prepended to all description
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	77 # unit titles (such as .. function::).
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	78 #add_module_names = True
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	79
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	80 # If true, sectionauthor and moduleauthor directives will be shown in the
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	81 # output. They are ignored by default.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	82 #show_authors = False
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	83
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	84 # The name of the Pygments (syntax highlighting) style to use.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	85 pygments_style = 'sphinx'
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	86
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	87 # A list of ignored prefixes for module index sorting.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	88 #modindex_common_prefix = []
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	89
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	90
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	91 # -- Options for HTML output ---------------------------------------------------
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	92
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	93 # The theme to use for HTML and HTML Help pages. See the documentation for
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	94 # a list of builtin themes.
188 43f1cbdcd597 Modified and beautified the documentation: Stephan Holl <stephan.holl@intevation.de> parents: 140 diff changeset	95 html_theme = 'sphinxdoc'
139 2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	96
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	97 # Theme options are theme-specific and customize the look and feel of a theme
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	98 # further. For a list of options available for each theme, see the
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	99 # documentation.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	100 #html_theme_options = {}
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	101
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	102 # Add any paths that contain custom themes here, relative to this directory.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	103 #html_theme_path = []
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	104
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	105 # The name for this set of Sphinx documents. If None, it defaults to
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	106 # "<project> v<release> documentation".
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	107 #html_title = None
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	108
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	109 # A shorter title for the navigation bar. Default is the same as html_title.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	110 #html_short_title = None
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	111
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	112 # The name of an image file (relative to this directory) to place at the top
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	113 # of the sidebar.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	114 #html_logo = None
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	115
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	116 # The name of an image file (within the static path) to use as favicon of the
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	117 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	118 # pixels large.
188 43f1cbdcd597 Modified and beautified the documentation: Stephan Holl <stephan.holl@intevation.de> parents: 140 diff changeset	119 html_favicon = '_static/favicon.png'
139 2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	120
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	121 # Add any paths that contain custom static files (such as style sheets) here,
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	122 # relative to this directory. They are copied after the builtin static files,
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	123 # so a file named "default.css" will overwrite the builtin "default.css".
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	124 html_static_path = ['_static']
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	125
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	126 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	127 # using the given strftime format.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	128 #html_last_updated_fmt = '%b %d, %Y'
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	129
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	130 # If true, SmartyPants will be used to convert quotes and dashes to
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	131 # typographically correct entities.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	132 #html_use_smartypants = True
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	133
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	134 # Custom sidebar templates, maps document names to template names.
188 43f1cbdcd597 Modified and beautified the documentation: Stephan Holl <stephan.holl@intevation.de> parents: 140 diff changeset	135 html_sidebars = {'index': ['indexsidebar.html', 'searchbox.html']}
139 2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	136
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	137 # Additional templates that should be rendered to pages, maps page names to
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	138 # template names.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	139 #html_additional_pages = {}
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	140
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	141 # If false, no module index is generated.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	142 #html_domain_indices = True
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	143
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	144 # If false, no index is generated.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	145 #html_use_index = True
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	146
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	147 # If true, the index is split into individual pages for each letter.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	148 #html_split_index = False
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	149
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	150 # If true, links to the reST sources are added to the pages.
188 43f1cbdcd597 Modified and beautified the documentation: Stephan Holl <stephan.holl@intevation.de> parents: 140 diff changeset	151 html_show_sourcelink = False
139 2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	152
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	153 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	154 #html_show_sphinx = True
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	155
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	156 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
188 43f1cbdcd597 Modified and beautified the documentation: Stephan Holl <stephan.holl@intevation.de> parents: 140 diff changeset	157 html_show_copyright = True
139 2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	158
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	159 # If true, an OpenSearch description file will be output, and all pages will
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	160 # contain a <link> tag referring to it. The value of this option must be the
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	161 # base URL from which the finished HTML is served.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	162 #html_use_opensearch = ''
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	163
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	164 # This is the file name suffix for HTML files (e.g. ".xhtml").
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	165 #html_file_suffix = None
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	166
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	167 # Output file base name for HTML help builder.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	168 htmlhelp_basename = 'MXD2mapdoc'
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	169
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	170
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	171 # -- Options for LaTeX output --------------------------------------------------
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	172
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	173 # The paper size ('letter' or 'a4').
188 43f1cbdcd597 Modified and beautified the documentation: Stephan Holl <stephan.holl@intevation.de> parents: 140 diff changeset	174 latex_paper_size = 'a4'
139 2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	175
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	176 # The font size ('10pt', '11pt' or '12pt').
188 43f1cbdcd597 Modified and beautified the documentation: Stephan Holl <stephan.holl@intevation.de> parents: 140 diff changeset	177 latex_font_size = '12pt'
139 2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	178
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	179 # Grouping the document tree into LaTeX files. List of tuples
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	180 # (source start file, target name, title, author, documentclass [howto/manual]).
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	181 latex_documents = [
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	182 ('index', 'MXD2map.tex', u'MXD2map Documentation',
188 43f1cbdcd597 Modified and beautified the documentation: Stephan Holl <stephan.holl@intevation.de> parents: 140 diff changeset	183 u'Raimund Renkert, Stephan Holl', 'manual'),
139 2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	184 ]
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	185
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	186 # The name of an image file (relative to this directory) to place at the top of
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	187 # the title page.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	188 #latex_logo = None
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	189
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	190 # For "manual" documents, if this is true, then toplevel headings are parts,
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	191 # not chapters.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	192 #latex_use_parts = False
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	193
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	194 # If true, show page references after internal links.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	195 #latex_show_pagerefs = False
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	196
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	197 # If true, show URL addresses after external links.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	198 #latex_show_urls = False
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	199
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	200 # Additional stuff for the LaTeX preamble.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	201 #latex_preamble = ''
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	202
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	203 # Documents to append as an appendix to all manuals.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	204 #latex_appendices = []
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	205
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	206 # If false, no module index is generated.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	207 #latex_domain_indices = True
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	208
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	209 latex_elements = {
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	210 'preamble': r'''\newcommand{\pyHeaderFamily}{\sffamily\bfseries}
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	211 \fancypagestyle{normal}{ \fancyhf{}
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	212 \fancyfoot[LE,RO]{{\pyHeaderFamily \thepage}}
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	213 \fancyfoot[LO]{{\pyHeaderFamily \nouppercase{\rightmark}}}
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	214 \fancyfoot[RE]{{\pyHeaderFamily \nouppercase{\leftmark}}}
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	215 \fancyhead[LE,RO]{{\pyHeaderFamily \title,
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	216 \releasename\space\version}}
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	217 \renewcommand{\headrulewidth}{0.4pt}
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	218 \renewcommand{\footrulewidth}{0.4pt}
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	219 % changes
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	220 %\fancyhead[LO,RE]{{\includegraphics[height=0.5cm]{InteProxy-logo.png}}}
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	221
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	222 }
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	223 ''',
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	224 'classoptions': ',oneside',
188 43f1cbdcd597 Modified and beautified the documentation: Stephan Holl <stephan.holl@intevation.de> parents: 140 diff changeset	225 'babel': '\\usepackage[english]{babel}'
139 2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	226 }
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	227
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	228
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	229 # -- Options for manual page output --------------------------------------------
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	230
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	231 # One entry per manual page. List of tuples
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	232 # (source start file, name, description, authors, manual section).
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	233 man_pages = [
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	234 ('index', 'mxd2map', u'MXD2map Documentation',
188 43f1cbdcd597 Modified and beautified the documentation: Stephan Holl <stephan.holl@intevation.de> parents: 140 diff changeset	235 [u'Raimund Renkert, Stephan Holl'], 1)
139 2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst, Stephan Holl <stephan.holl@intevation.de> parents: diff changeset	236 ]

Mercurial > mxd2map > mxd2map

annotate doku/source/conf.py @ 188:43f1cbdcd597