1 | # -*- coding: utf-8 -*- |
---|
2 | # |
---|
3 | # Workshop - FOSS4G routing with pgRouting tools, OpenStreetMap road data and GeoExt documentation build configuration file, created by |
---|
4 | # sphinx-quickstart on Sat Jul 3 21:23:22 2010. |
---|
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.append(os.path.abspath('.')) |
---|
20 | |
---|
21 | # -- General configuration ----------------------------------------------------- |
---|
22 | |
---|
23 | # Add any Sphinx extension module names here, as strings. They can be extensions |
---|
24 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
---|
25 | extensions = ['sphinx.ext.todo'] |
---|
26 | |
---|
27 | # Add any paths that contain templates here, relative to this directory. |
---|
28 | templates_path = ['_templates'] |
---|
29 | |
---|
30 | # The suffix of source filenames. |
---|
31 | source_suffix = '.rst' |
---|
32 | |
---|
33 | # The encoding of source files. |
---|
34 | #source_encoding = 'utf-8' |
---|
35 | |
---|
36 | # The master toctree document. |
---|
37 | master_doc = 'index' |
---|
38 | |
---|
39 | # General information about the project. |
---|
40 | project = u'Workshop - FOSS4G routing with pgRouting tools, OpenStreetMap road data and GeoExt' |
---|
41 | copyright = u'2010-2011 Daniel Kastl, Frédéric Junod' |
---|
42 | |
---|
43 | # The version info for the project you're documenting, acts as replacement for |
---|
44 | # |version| and |release|, also used in various other places throughout the |
---|
45 | # built documents. |
---|
46 | # |
---|
47 | # The short X.Y version. |
---|
48 | version = '2011' |
---|
49 | # The full version, including alpha/beta/rc tags. |
---|
50 | release = '2' |
---|
51 | |
---|
52 | # The language for content autogenerated by Sphinx. Refer to documentation |
---|
53 | # for a list of supported languages. |
---|
54 | #language = None |
---|
55 | |
---|
56 | # There are two options for replacing |today|: either, you set today to some |
---|
57 | # non-false value, then it is used: |
---|
58 | #today = '' |
---|
59 | # Else, today_fmt is used as the format for a strftime call. |
---|
60 | #today_fmt = '%B %d, %Y' |
---|
61 | |
---|
62 | # List of documents that shouldn't be included in the build. |
---|
63 | #unused_docs = [] |
---|
64 | |
---|
65 | # List of directories, relative to source directory, that shouldn't be searched |
---|
66 | # for source files. |
---|
67 | exclude_trees = ['_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. Major themes that come with |
---|
93 | # Sphinx are currently 'default' and 'sphinxdoc'. |
---|
94 | html_theme = 'default' |
---|
95 | |
---|
96 | # 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 | # documentation. |
---|
99 | html_theme_options = { |
---|
100 | #"rightsidebar": "true", |
---|
101 | "stickysidebar": "true", |
---|
102 | "footerbgcolor": "#FFEEFF", |
---|
103 | "footertextcolor": "#555555", |
---|
104 | "sidebarbgcolor": "#FFEEFF", |
---|
105 | "sidebartextcolor": "#111111", |
---|
106 | "sidebarlinkcolor": "#355F7C", |
---|
107 | #"bgcolor": "", |
---|
108 | #"textcolor": "", |
---|
109 | #"linkcolor": "", |
---|
110 | #"headbgcolor": "", |
---|
111 | #"headtextcolor": "", |
---|
112 | #"headlinkcolor": "", |
---|
113 | #"codebgcolor": "", |
---|
114 | #"codetextcolor": "", |
---|
115 | #"bodyfont": "", |
---|
116 | #"headfont": "", |
---|
117 | #"relbartextcolor": "", |
---|
118 | #"relbarlinkcolor": "", |
---|
119 | "relbarbgcolor": "#555555" |
---|
120 | } |
---|
121 | |
---|
122 | # Add any paths that contain custom themes here, relative to this directory. |
---|
123 | #html_theme_path = [] |
---|
124 | |
---|
125 | # The name for this set of Sphinx documents. If None, it defaults to |
---|
126 | # "<project> v<release> documentation". |
---|
127 | html_title = "Workshop - FOSS4G routing with pgRouting tools, OpenStreetMap road data and GeoExt" |
---|
128 | |
---|
129 | # A shorter title for the navigation bar. Default is the same as html_title. |
---|
130 | html_short_title = "Workshop - FOSS4G routing with pgRouting tools, OpenStreetMap road data and GeoExt" |
---|
131 | |
---|
132 | # The name of an image file (relative to this directory) to place at the top |
---|
133 | # of the sidebar. |
---|
134 | html_logo = "_static/pgrouting.png" |
---|
135 | |
---|
136 | # The name of an image file (within the static path) to use as favicon of the |
---|
137 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 |
---|
138 | # pixels large. |
---|
139 | html_favicon = "_static/favicon.ico" |
---|
140 | |
---|
141 | # Add any paths that contain custom static files (such as style sheets) here, |
---|
142 | # relative to this directory. They are copied after the builtin static files, |
---|
143 | # so a file named "default.css" will overwrite the builtin "default.css". |
---|
144 | html_static_path = ['_static'] |
---|
145 | |
---|
146 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
---|
147 | # using the given strftime format. |
---|
148 | html_last_updated_fmt = '%b %d, %Y' |
---|
149 | |
---|
150 | # If true, SmartyPants will be used to convert quotes and dashes to |
---|
151 | # typographically correct entities. |
---|
152 | #html_use_smartypants = True |
---|
153 | |
---|
154 | # Custom sidebar templates, maps document names to template names. |
---|
155 | #html_sidebars = {} |
---|
156 | |
---|
157 | # Additional templates that should be rendered to pages, maps page names to |
---|
158 | # template names. |
---|
159 | #html_additional_pages = {} |
---|
160 | |
---|
161 | # If false, no module index is generated. |
---|
162 | #html_use_modindex = True |
---|
163 | |
---|
164 | # If false, no index is generated. |
---|
165 | html_use_index = False |
---|
166 | |
---|
167 | # If true, the index is split into individual pages for each letter. |
---|
168 | #html_split_index = False |
---|
169 | |
---|
170 | # If true, links to the reST sources are added to the pages. |
---|
171 | html_show_sourcelink = False |
---|
172 | |
---|
173 | # If true, an OpenSearch description file will be output, and all pages will |
---|
174 | # contain a <link> tag referring to it. The value of this option must be the |
---|
175 | # base URL from which the finished HTML is served. |
---|
176 | #html_use_opensearch = '' |
---|
177 | |
---|
178 | # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). |
---|
179 | #html_file_suffix = '' |
---|
180 | |
---|
181 | # Output file base name for HTML help builder. |
---|
182 | htmlhelp_basename = 'pgRoutingWorkshop' |
---|
183 | |
---|
184 | |
---|
185 | # -- Options for LaTeX output -------------------------------------------------- |
---|
186 | |
---|
187 | latex_elements = { |
---|
188 | 'papersize' : 'letter', |
---|
189 | 'pointsize' : '10pt' |
---|
190 | } |
---|
191 | |
---|
192 | # Grouping the document tree into LaTeX files. List of tuples |
---|
193 | # (source start file, target name, title, author, documentclass [howto/manual]). |
---|
194 | latex_documents = [ |
---|
195 | ('latex', 'pgRoutingWorkshop.tex', u'Workshop - FOSS4G routing with pgRouting tools, OpenStreetMap road data and GeoExt Manual', |
---|
196 | u'Daniel Kastl, Frédéric Junod', 'manual', False), |
---|
197 | ] |
---|
198 | |
---|
199 | # The name of an image file (relative to this directory) to place at the top of |
---|
200 | # the title page. |
---|
201 | #latex_logo = None |
---|
202 | |
---|
203 | # For "manual" documents, if this is true, then toplevel headings are parts, |
---|
204 | # not chapters. |
---|
205 | #latex_use_parts = False |
---|
206 | |
---|
207 | # Additional stuff for the LaTeX preamble. |
---|
208 | #latex_preamble = '' |
---|
209 | |
---|
210 | # Documents to append as an appendix to all manuals. |
---|
211 | #latex_appendices = [] |
---|
212 | |
---|
213 | # If false, no module index is generated. |
---|
214 | latex_use_modindex = False |
---|
215 | |
---|
216 | # New in version 1.0 |
---|
217 | latex_show_pagerefs = False |
---|
218 | latex_domain_indices = False |
---|
219 | |
---|
220 | |
---|
221 | # -- Custom Options -------------------------------------------------- |
---|
222 | |
---|
223 | # Enable ToDo extension |
---|
224 | todo_include_todos = True |
---|
225 | |
---|
226 | html_show_sphinx = False |
---|
227 | |
---|