annotate doku/source/conf.py @ 300:215ae6199b95

Add WMS Support to the writer
author Andre Heinecke <aheinecke@intevation.de>
date Wed, 05 Sep 2012 16:15:03 +0200
parents b2df9936d4f8
children 4051c39757db
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'
235
00a39e8b6eed * INSTALL.txt: Added a paragraph to make the env-vars available in Apache
Stephan Holl <stephan.holl@intevation.de>
parents: 220
diff changeset
44 copyright = u'2011, Intevation GmbH'
139
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
45
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
46 # 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
47 # |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
48 # built documents.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
49 #
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
50 # The short X.Y version.
277
b2df9936d4f8 * doku/source/conf.py, contrib/installer/MXD2map-installer.nsi:
Stephan Holl <stephan.holl@intevation.de>
parents: 269
diff changeset
51 version = '1.0'
139
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
52 # The full version, including alpha/beta/rc tags.
277
b2df9936d4f8 * doku/source/conf.py, contrib/installer/MXD2map-installer.nsi:
Stephan Holl <stephan.holl@intevation.de>
parents: 269
diff changeset
53 release = '1.0.0'
139
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
54
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
55 # 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
56 # for a list of supported languages.
202
1e3a5019c4ed * INSTALL.txt, LICENCE.txt, doku/source/LICENCE.txt,
Stephan Holl <stephan.holl@intevation.de>
parents: 188
diff changeset
57 #language = 'en'
139
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
58
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
59 # 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
60 # 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
61 #today = ''
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
62 # Else, today_fmt is used as the format for a strftime call.
220
671737e8edc2 Make date visible in documentation
Stephan Holl <stephan.holl@intevation.de>
parents: 202
diff changeset
63 today_fmt = '%d.%m.%Y %H:%M'
139
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
64
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
65 # 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
66 # 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
67 exclude_patterns = []
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
68
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
69 # 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
70 #default_role = None
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
71
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
72 # 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
73 #add_function_parentheses = True
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
74
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
75 # 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
76 # 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
77 #add_module_names = True
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
78
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
79 # 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
80 # 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
81 #show_authors = False
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
82
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
83 # 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
84 pygments_style = 'sphinx'
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
85
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
86 # 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
87 #modindex_common_prefix = []
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
88
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 # -- Options for HTML output ---------------------------------------------------
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
91
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
92 # 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
93 # a list of builtin themes.
188
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 140
diff changeset
94 html_theme = 'sphinxdoc'
139
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
95
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
96 # 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
97 # 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
98 # documentation.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
99 #html_theme_options = {}
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
100
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
101 # 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
102 #html_theme_path = []
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
103
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
104 # 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
105 # "<project> v<release> documentation".
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
106 #html_title = None
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
107
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
108 # 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
109 #html_short_title = None
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
110
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
111 # 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
112 # of the sidebar.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
113 #html_logo = None
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
114
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
115 # 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
116 # 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
117 # pixels large.
188
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 140
diff changeset
118 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
119
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
120 # 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
121 # 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
122 # 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
123 html_static_path = ['_static']
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
124
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
125 # 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
126 # using the given strftime format.
220
671737e8edc2 Make date visible in documentation
Stephan Holl <stephan.holl@intevation.de>
parents: 202
diff changeset
127 html_last_updated_fmt = '%d.%m.%Y, %H:%M'
139
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
128
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
129 # 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
130 # typographically correct entities.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
131 #html_use_smartypants = True
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
132
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
133 # 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
134 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
135
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
136 # 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
137 # template names.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
138 #html_additional_pages = {}
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
139
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
140 # 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
141 #html_domain_indices = True
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
142
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
143 # 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
144 #html_use_index = True
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
145
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
146 # 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
147 #html_split_index = False
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
148
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
149 # 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
150 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
151
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
152 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
202
1e3a5019c4ed * INSTALL.txt, LICENCE.txt, doku/source/LICENCE.txt,
Stephan Holl <stephan.holl@intevation.de>
parents: 188
diff changeset
153 html_show_sphinx = False
139
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
154
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
155 # 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
156 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
157
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
158 # 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
159 # 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
160 # 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
161 #html_use_opensearch = ''
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
162
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
163 # 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
164 #html_file_suffix = None
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
165
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
166 # 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
167 htmlhelp_basename = 'MXD2mapdoc'
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
168
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 # -- Options for LaTeX output --------------------------------------------------
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
171
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
172 # The paper size ('letter' or 'a4').
188
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 140
diff changeset
173 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
174
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
175 # The font size ('10pt', '11pt' or '12pt').
188
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 140
diff changeset
176 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
177
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
178 # 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
179 # (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
180 latex_documents = [
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
181 ('index', 'MXD2map.tex', u'MXD2map Documentation',
188
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 140
diff changeset
182 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
183 ]
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 # 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
186 # the title page.
202
1e3a5019c4ed * INSTALL.txt, LICENCE.txt, doku/source/LICENCE.txt,
Stephan Holl <stephan.holl@intevation.de>
parents: 188
diff changeset
187 latex_logo = '_static/logo_wide.png'
139
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
188
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
189 # 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
190 # not chapters.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
191 #latex_use_parts = False
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
192
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
193 # 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
194 #latex_show_pagerefs = False
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
195
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
196 # 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
197 #latex_show_urls = False
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
198
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
199 # 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
200 #latex_preamble = ''
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
201
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
202 # 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
203 #latex_appendices = []
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
204
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
205 # 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
206 #latex_domain_indices = True
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
207
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
208 latex_elements = {
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
209 '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
210 \fancypagestyle{normal}{ \fancyhf{}
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
211 \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
212 \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
213 \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
214 \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
215 \releasename\space\version}}
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
216 \renewcommand{\headrulewidth}{0.4pt}
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
217 \renewcommand{\footrulewidth}{0.4pt}
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
218 % changes
202
1e3a5019c4ed * INSTALL.txt, LICENCE.txt, doku/source/LICENCE.txt,
Stephan Holl <stephan.holl@intevation.de>
parents: 188
diff changeset
219 %\fancyhead[LO,RE]{{\includegraphics[height=0.5cm]{_static/logo-wide.png}}}
139
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
220
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 'classoptions': ',oneside',
188
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 140
diff changeset
224 '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
225 }
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 # -- 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
229
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
230 # 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
231 # (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
232 man_pages = [
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
233 ('index', 'mxd2map', u'MXD2map Documentation',
188
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 140
diff changeset
234 [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
235 ]
This site is hosted by Intevation GmbH (Datenschutzerklärung und Impressum | Privacy Policy and Imprint)