Mercurial > mxd2map

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

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
comparison
equal deleted inserted replaced
187:ea7858d75459 188:43f1cbdcd597
39 # The master toctree document. 39 # The master toctree document.
40 master_doc = 'index' 40 master_doc = 'index'
41 41
42 # General information about the project. 42 # General information about the project.
43 project = u'MXD2map' 43 project = u'MXD2map'
44 copyright = u'2011, foo bar' 44 copyright = u'2011, Bundesamt fuer Seeschifffahrt und Hydrographie,
45 Intevation GmbH'
45 46
46 # The version info for the project you're documenting, acts as replacement for 47 # The version info for the project you're documenting, acts as replacement for
47 # |version| and |release|, also used in various other places throughout the 48 # |version| and |release|, also used in various other places throughout the
48 # built documents. 49 # built documents.
49 # 50 #
50 # The short X.Y version. 51 # The short X.Y version.
51 version = '0.0.1' 52 version = '0.1'
52 # The full version, including alpha/beta/rc tags. 53 # The full version, including alpha/beta/rc tags.
53 release = '0.0.1' 54 release = '0.1'
54 55
55 # The language for content autogenerated by Sphinx. Refer to documentation 56 # The language for content autogenerated by Sphinx. Refer to documentation
56 # for a list of supported languages. 57 # for a list of supported languages.
57 language = 'de' 58 language = 'en'
58 59
59 # There are two options for replacing |today|: either, you set today to some 60 # There are two options for replacing |today|: either, you set today to some
60 # non-false value, then it is used: 61 # non-false value, then it is used:
61 #today = '' 62 #today = ''
62 # Else, today_fmt is used as the format for a strftime call. 63 # Else, today_fmt is used as the format for a strftime call.
89 90
90 # -- Options for HTML output --------------------------------------------------- 91 # -- Options for HTML output ---------------------------------------------------
91 92
92 # The theme to use for HTML and HTML Help pages. See the documentation for 93 # The theme to use for HTML and HTML Help pages. See the documentation for
93 # a list of builtin themes. 94 # a list of builtin themes.
94 html_theme = 'default' 95 html_theme = 'sphinxdoc'
95 96
96 # Theme options are theme-specific and customize the look and feel of a theme 97 # Theme options are theme-specific and customize the look and feel of a theme
97 # further. For a list of options available for each theme, see the 98 # further. For a list of options available for each theme, see the
98 # documentation. 99 # documentation.
99 #html_theme_options = {} 100 #html_theme_options = {}
113 #html_logo = None 114 #html_logo = None
114 115
115 # The name of an image file (within the static path) to use as favicon of the 116 # The name of an image file (within the static path) to use as favicon of the
116 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 117 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
117 # pixels large. 118 # pixels large.
118 #html_favicon = None 119 html_favicon = '_static/favicon.png'
119 120
120 # Add any paths that contain custom static files (such as style sheets) here, 121 # Add any paths that contain custom static files (such as style sheets) here,
121 # relative to this directory. They are copied after the builtin static files, 122 # relative to this directory. They are copied after the builtin static files,
122 # so a file named "default.css" will overwrite the builtin "default.css". 123 # so a file named "default.css" will overwrite the builtin "default.css".
123 html_static_path = ['_static'] 124 html_static_path = ['_static']
129 # If true, SmartyPants will be used to convert quotes and dashes to 130 # If true, SmartyPants will be used to convert quotes and dashes to
130 # typographically correct entities. 131 # typographically correct entities.
131 #html_use_smartypants = True 132 #html_use_smartypants = True
132 133
133 # Custom sidebar templates, maps document names to template names. 134 # Custom sidebar templates, maps document names to template names.
134 #html_sidebars = {} 135 html_sidebars = {'index': ['indexsidebar.html', 'searchbox.html']}
135 136
136 # Additional templates that should be rendered to pages, maps page names to 137 # Additional templates that should be rendered to pages, maps page names to
137 # template names. 138 # template names.
138 #html_additional_pages = {} 139 #html_additional_pages = {}
139 140
145 146
146 # If true, the index is split into individual pages for each letter. 147 # If true, the index is split into individual pages for each letter.
147 #html_split_index = False 148 #html_split_index = False
148 149
149 # If true, links to the reST sources are added to the pages. 150 # If true, links to the reST sources are added to the pages.
150 #html_show_sourcelink = True 151 html_show_sourcelink = False
151 152
152 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. 153 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
153 #html_show_sphinx = True 154 #html_show_sphinx = True
154 155
155 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. 156 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
156 #html_show_copyright = True 157 html_show_copyright = True
157 158
158 # If true, an OpenSearch description file will be output, and all pages will 159 # If true, an OpenSearch description file will be output, and all pages will
159 # contain a <link> tag referring to it. The value of this option must be the 160 # contain a <link> tag referring to it. The value of this option must be the
160 # base URL from which the finished HTML is served. 161 # base URL from which the finished HTML is served.
161 #html_use_opensearch = '' 162 #html_use_opensearch = ''
168 169
169 170
170 # -- Options for LaTeX output -------------------------------------------------- 171 # -- Options for LaTeX output --------------------------------------------------
171 172
172 # The paper size ('letter' or 'a4'). 173 # The paper size ('letter' or 'a4').
173 #latex_paper_size = 'letter' 174 latex_paper_size = 'a4'
174 175
175 # The font size ('10pt', '11pt' or '12pt'). 176 # The font size ('10pt', '11pt' or '12pt').
176 #latex_font_size = '10pt' 177 latex_font_size = '12pt'
177 178
178 # Grouping the document tree into LaTeX files. List of tuples 179 # Grouping the document tree into LaTeX files. List of tuples
179 # (source start file, target name, title, author, documentclass [howto/manual]). 180 # (source start file, target name, title, author, documentclass [howto/manual]).
180 latex_documents = [ 181 latex_documents = [
181 ('index', 'MXD2map.tex', u'MXD2map Documentation', 182 ('index', 'MXD2map.tex', u'MXD2map Documentation',
182 u'foo bar', 'manual'), 183 u'Raimund Renkert, Stephan Holl', 'manual'),
183 ] 184 ]
184 185
185 # The name of an image file (relative to this directory) to place at the top of 186 # The name of an image file (relative to this directory) to place at the top of
186 # the title page. 187 # the title page.
187 #latex_logo = None 188 #latex_logo = None
219 %\fancyhead[LO,RE]{{\includegraphics[height=0.5cm]{InteProxy-logo.png}}} 220 %\fancyhead[LO,RE]{{\includegraphics[height=0.5cm]{InteProxy-logo.png}}}
220 221
221 } 222 }
222 ''', 223 ''',
223 'classoptions': ',oneside', 224 'classoptions': ',oneside',
224 'babel': '\\usepackage[ngerman,german]{babel}' 225 'babel': '\\usepackage[english]{babel}'
225 } 226 }
226 227
227 228
228 # -- Options for manual page output -------------------------------------------- 229 # -- Options for manual page output --------------------------------------------
229 230
230 # One entry per manual page. List of tuples 231 # One entry per manual page. List of tuples
231 # (source start file, name, description, authors, manual section). 232 # (source start file, name, description, authors, manual section).
232 man_pages = [ 233 man_pages = [
233 ('index', 'mxd2map', u'MXD2map Documentation', 234 ('index', 'mxd2map', u'MXD2map Documentation',
234 [u'foo bar'], 1) 235 [u'Raimund Renkert, Stephan Holl'], 1)
235 ] 236 ]
This site is hosted by Intevation GmbH (Datenschutzerklärung und Impressum | Privacy Policy and Imprint)