comparison manuals/help-manual/conf.py @ 903:b5a49960d5cb

Added first draft of manuals for TrustBridge and TrustBridge Admin (using Sphinx).
author Emanuel Schuetze <emanuel@intevation.de>
date Wed, 13 Aug 2014 14:49:25 +0200
parents
children d6dc1144895b
comparison
equal deleted inserted replaced
902:f5a48c228e9b 903:b5a49960d5cb
1 # -*- coding: utf-8 -*-
2 #
3 # Dokumentationsvorlage documentation build configuration file, created by
4 # sphinx-quickstart on Fri Dec 14 12:07:59 2012.
5 #
6 # This file is execfile()d with the current directory set to its containing dir.
7 #
8 # Note that not all possible configuration values are present in this
9 # autogenerated file.
10 #
11 # All configuration values have a default; values that are commented out
12 # serve to show the default.
13
14 import sys, os
15
16 # If extensions (or modules to document with autodoc) are in another directory,
17 # add these directories to sys.path here. If the directory is relative to the
18 # documentation root, use os.path.abspath to make it absolute, like shown here.
19 #sys.path.insert(0, os.path.abspath('extensions'))
20
21 # -- General configuration -----------------------------------------------------
22
23 # If your documentation needs a minimal Sphinx version, state it here.
24 #needs_sphinx = '1.0'
25
26 # Add any Sphinx extension module names here, as strings. They can be extensions
27 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
28 #extensions = ['']
29
30 # Add any paths that contain templates here, relative to this directory.
31 templates_path = ['_templates']
32
33 # The suffix of source filenames.
34 source_suffix = '.rst'
35
36 # The encoding of source files.
37 #source_encoding = 'utf-8-sig'
38
39 # The master toctree document.
40 master_doc = 'index'
41
42 # General information about the project.
43 project = u'TrustBridge-Hilfe'
44 copyright = u'2014, BSI'
45
46 # 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 # built documents.
49 #
50 # The short X.Y version.
51 version = '1.0'
52 # The full version, including alpha/beta/rc tags.
53 release = '1.0'
54
55 # The language for content autogenerated by Sphinx. Refer to documentation
56 # for a list of supported languages.
57 language = 'de'
58
59 # There are two options for replacing |today|: either, you set today to some
60 # non-false value, then it is used:
61 #today = ''
62 # Else, today_fmt is used as the format for a strftime call.
63 #today_fmt = '%B %d, %Y'
64
65 # List of patterns, relative to source directory, that match files and
66 # directories to ignore when looking for source files.
67 exclude_patterns = ['_build']
68
69 # The reST default role (used for this markup: `text`) to use for all documents.
70 #default_role = None
71
72 # If true, '()' will be appended to :func: etc. cross-reference text.
73 #add_function_parentheses = True
74
75 # If true, the current module name will be prepended to all description
76 # unit titles (such as .. function::).
77 #add_module_names = True
78
79 # If true, sectionauthor and moduleauthor directives will be shown in the
80 # output. They are ignored by default.
81 #show_authors = False
82
83 # The name of the Pygments (syntax highlighting) style to use.
84 pygments_style = 'sphinx'
85
86 # A list of ignored prefixes for module index sorting.
87 #modindex_common_prefix = []
88
89
90 # -- Options for HTML output ---------------------------------------------------
91
92 # The theme to use for HTML and HTML Help pages. See the documentation for
93 # a list of builtin themes.
94 from better import better_theme_path
95 html_theme_path = [better_theme_path]
96 html_theme = 'better'
97
98 # Theme options are theme-specific and customize the look and feel of a theme
99 # further. For a list of options available for each theme, see the
100 # documentation.
101 html_theme_options = {
102 'linktotheme': False,
103 'cssfiles': ['_static/extra-style.css'],
104 }
105
106 # Add any paths that contain custom themes here, relative to this directory.
107 #html_theme_path = []
108
109 # The name for this set of Sphinx documents. If None, it defaults to
110 # "<project> v<release> documentation".
111 html_title = 'TrustBridge-Hilfe'
112
113 # A shorter title for the navigation bar. Default is the same as html_title.
114 html_short_title = 'Home'
115
116 # The name of an image file (relative to this directory) to place at the top
117 # of the sidebar.
118 #html_logo = None
119
120 # The name of an image file (within the static path) to use as favicon of the
121 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
122 # pixels large.
123 #html_favicon = None
124
125 # Add any paths that contain custom static files (such as style sheets) here,
126 # relative to this directory. They are copied after the builtin static files,
127 # so a file named "default.css" will overwrite the builtin "default.css".
128 html_static_path = ['_static']
129
130 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
131 # using the given strftime format.
132 #html_last_updated_fmt = '%b %d, %Y'
133
134 # If true, SmartyPants will be used to convert quotes and dashes to
135 # typographically correct entities.
136 #html_use_smartypants = True
137
138 # Custom sidebar templates, maps document names to template names.
139 html_sidebars = {
140 '**': ['globaltoc.html', 'searchbox.html'],
141 }
142
143 # Additional templates that should be rendered to pages, maps page names to
144 # template names.
145 #html_additional_pages = {}
146
147 # If false, no module index is generated.
148 #html_domain_indices = True
149
150 # If false, no index is generated.
151 #html_use_index = True
152
153 # If true, the index is split into individual pages for each letter.
154 #html_split_index = False
155
156 # If true, links to the reST sources are added to the pages.
157 #html_show_sourcelink = True
158
159 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
160 html_show_sphinx = False
161
162 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
163 #html_show_copyright = True
164
165 # If true, an OpenSearch description file will be output, and all pages will
166 # contain a <link> tag referring to it. The value of this option must be the
167 # base URL from which the finished HTML is served.
168 #html_use_opensearch = ''
169
170 # This is the file name suffix for HTML files (e.g. ".xhtml").
171 #html_file_suffix = None
172
173 # Output file base name for HTML help builder.
174 # htmlhelp_basename = ''
175
176
177 # -- Options for LaTeX output --------------------------------------------------
178
179 latex_elements = {
180 # The paper size ('letterpaper' or 'a4paper').
181 'papersize': 'a4paper,oneside',
182
183 # The font size ('10pt', '11pt' or '12pt').
184 'pointsize': '11pt',
185
186 # Additional stuff for the LaTeX preamble.
187 'preamble':
188 '\\usepackage{colortbl} '\
189 '\\usepackage{booktabs} '\
190 '\\usepackage{tabularx} '\
191 '\\newcommand{\\projecttitle}{} '\
192 '\\newcommand{\\documenttype}{TrustBridge-Benutzerdokumentation} '\
193 '\\newcommand{\\documentdate}{12. August 2014} '\
194 '\\newcommand{\\documentversion}{Version 0.1} '\
195 '\\newcommand{\\customer}{BSI} '\
196 '',
197
198 'babel': '\usepackage[ngerman]{babel}',
199 'fncychap' : '',
200
201 'maketitle':
202 # Titelseite
203 '\\includegraphics[height=2cm]{brieflogo-neu.png} \\\\[2.5cm] '\
204 '{\\sffamily\\bfseries\\large \\projecttitle \\\\[0.5cm] '\
205 '\\huge \\documenttype \\\\[2.5cm]'\
206 '\\small \\documentdate, \\documentversion \\\\[2.5cm]'\
207 '\\sffamily\\bfseries\\small '\
208 'Autor: Intevation GmbH\\\\[1.0cm] '\
209 '} '\
210 '',
211 }
212
213 # Grouping the document tree into LaTeX files. List of tuples
214 # (source start file, target name, title, author, documentclass [howto/manual]).
215 latex_documents = [
216 ('index', 'TrustBridge-Hilfe.tex', u'TrustBridge-Hilfe',
217 u'Intevation GmbH', 'manual'),
218 ]
219
220 latex_docclass = { 'manual': 'scrreprt', }
221
222 # The name of an image file (relative to this directory) to place at the top of
223 # the title page.
224 #latex_logo = None
225
226 # For "manual" documents, if this is true, then toplevel headings are parts,
227 # not chapters.
228 latex_use_parts = False
229
230 # If true, show page references after internal links.
231 #latex_show_pagerefs = False
232
233 # If true, show URL addresses after external links.
234 #latex_show_urls = False
235
236 # Documents to append as an appendix to all manuals.
237 #latex_appendices = []
238
239 # If false, no module index is generated.
240 #latex_domain_indices = True

http://wald.intevation.org/projects/trustbridge/