1 | # -*- coding: utf-8 -*- |
---|
2 | # |
---|
3 | # igcmg_doc documentation build configuration file, created by |
---|
4 | # sphinx-quickstart on Thu Sep 24 15:42:29 2015. |
---|
5 | # |
---|
6 | # This file is execfile()d with the current directory set to its |
---|
7 | # containing dir. |
---|
8 | # |
---|
9 | # Note that not all possible configuration values are present in this |
---|
10 | # autogenerated file. |
---|
11 | # |
---|
12 | # All configuration values have a default; values that are commented out |
---|
13 | # serve to show the default. |
---|
14 | |
---|
15 | import sys |
---|
16 | import os |
---|
17 | import shlex |
---|
18 | |
---|
19 | # If extensions (or modules to document with autodoc) are in another directory, |
---|
20 | # add these directories to sys.path here. If the directory is relative to the |
---|
21 | # documentation root, use os.path.abspath to make it absolute, like shown here. |
---|
22 | #sys.path.insert(0, os.path.abspath('.')) |
---|
23 | |
---|
24 | # -- General configuration ------------------------------------------------ |
---|
25 | |
---|
26 | # If your documentation needs a minimal Sphinx version, state it here. |
---|
27 | #needs_sphinx = '1.0' |
---|
28 | |
---|
29 | # Add any Sphinx extension module names here, as strings. They can be |
---|
30 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
---|
31 | # ones. |
---|
32 | extensions = [ |
---|
33 | 'sphinx.ext.autodoc', |
---|
34 | 'sphinx.ext.doctest', |
---|
35 | 'sphinx.ext.intersphinx', |
---|
36 | 'sphinx.ext.todo', |
---|
37 | 'sphinx.ext.coverage', |
---|
38 | 'sphinx.ext.mathjax', |
---|
39 | 'sphinx.ext.ifconfig', |
---|
40 | 'sphinx.ext.viewcode', |
---|
41 | 'sphinx.ext.graphviz', |
---|
42 | 'sphinxcontrib.blockdiag', |
---|
43 | ] |
---|
44 | |
---|
45 | # Enable debug mode of blockdiag. |
---|
46 | blockdiag_debug = True |
---|
47 | # Add any paths that contain templates here, relative to this directory. |
---|
48 | templates_path = ['_templates'] |
---|
49 | |
---|
50 | # The suffix(es) of source filenames. |
---|
51 | # You can specify multiple suffix as a list of string: |
---|
52 | # source_suffix = ['.rst', '.md'] |
---|
53 | source_suffix = '.rst' |
---|
54 | |
---|
55 | # The encoding of source files. |
---|
56 | #source_encoding = 'utf-8-sig' |
---|
57 | |
---|
58 | # The master toctree document. |
---|
59 | master_doc = 'index' |
---|
60 | |
---|
61 | # General information about the project. |
---|
62 | project = u'igcmg_doc' |
---|
63 | copyright = u'2015, igcmg' |
---|
64 | author = u'igcmg' |
---|
65 | |
---|
66 | # The version info for the project you're documenting, acts as replacement for |
---|
67 | # |version| and |release|, also used in various other places throughout the |
---|
68 | # built documents. |
---|
69 | # |
---|
70 | # The short X.Y version. |
---|
71 | version = '2.0' |
---|
72 | # The full version, including alpha/beta/rc tags. |
---|
73 | release = '2.0' |
---|
74 | |
---|
75 | # The language for content autogenerated by Sphinx. Refer to documentation |
---|
76 | # for a list of supported languages. |
---|
77 | # |
---|
78 | # This is also used if you do content translation via gettext catalogs. |
---|
79 | # Usually you set "language" from the command line for these cases. |
---|
80 | language = None |
---|
81 | |
---|
82 | # There are two options for replacing |today|: either, you set today to some |
---|
83 | # non-false value, then it is used: |
---|
84 | #today = '' |
---|
85 | # Else, today_fmt is used as the format for a strftime call. |
---|
86 | #today_fmt = '%B %d, %Y' |
---|
87 | |
---|
88 | # List of patterns, relative to source directory, that match files and |
---|
89 | # directories to ignore when looking for source files. |
---|
90 | exclude_patterns = ['_build', 'prolog.rst'] |
---|
91 | |
---|
92 | # Included at the beginning of every source file that is read. |
---|
93 | with open('prolog.rst', 'r') as pr: |
---|
94 | rst_prolog = pr.read() |
---|
95 | |
---|
96 | rst_prolog |
---|
97 | |
---|
98 | # The reST default role (used for this markup: `text`) to use for all |
---|
99 | # documents. |
---|
100 | #default_role = None |
---|
101 | |
---|
102 | # If true, '()' will be appended to :func: etc. cross-reference text. |
---|
103 | #add_function_parentheses = True |
---|
104 | |
---|
105 | # If true, the current module name will be prepended to all description |
---|
106 | # unit titles (such as .. function::). |
---|
107 | #add_module_names = True |
---|
108 | |
---|
109 | # If true, sectionauthor and moduleauthor directives will be shown in the |
---|
110 | # output. They are ignored by default. |
---|
111 | #show_authors = False |
---|
112 | |
---|
113 | # The name of the Pygments (syntax highlighting) style to use. |
---|
114 | pygments_style = 'sphinx' |
---|
115 | |
---|
116 | # A list of ignored prefixes for module index sorting. |
---|
117 | #modindex_common_prefix = [] |
---|
118 | |
---|
119 | # If true, keep warnings as "system message" paragraphs in the built documents. |
---|
120 | #keep_warnings = False |
---|
121 | |
---|
122 | # If true, `todo` and `todoList` produce output, else they produce nothing. |
---|
123 | todo_include_todos = True |
---|
124 | |
---|
125 | |
---|
126 | # -- Options for HTML output ---------------------------------------------- |
---|
127 | |
---|
128 | # The theme to use for HTML and HTML Help pages. See the documentation for |
---|
129 | # a list of builtin themes. |
---|
130 | html_theme = 'alabaster' |
---|
131 | |
---|
132 | # Theme options are theme-specific and customize the look and feel of a theme |
---|
133 | # further. For a list of options available for each theme, see the |
---|
134 | # documentation. |
---|
135 | #html_theme_options = {} |
---|
136 | |
---|
137 | # Add any paths that contain custom themes here, relative to this directory. |
---|
138 | #html_theme_path = [] |
---|
139 | |
---|
140 | # The name for this set of Sphinx documents. If None, it defaults to |
---|
141 | # "<project> v<release> documentation". |
---|
142 | #html_title = None |
---|
143 | |
---|
144 | # A shorter title for the navigation bar. Default is the same as html_title. |
---|
145 | #html_short_title = None |
---|
146 | |
---|
147 | # The name of an image file (relative to this directory) to place at the top |
---|
148 | # of the sidebar. |
---|
149 | #html_logo = None |
---|
150 | |
---|
151 | # The name of an image file (within the static path) to use as favicon of the |
---|
152 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 |
---|
153 | # pixels large. |
---|
154 | #html_favicon = None |
---|
155 | |
---|
156 | # Add any paths that contain custom static files (such as style sheets) here, |
---|
157 | # relative to this directory. They are copied after the builtin static files, |
---|
158 | # so a file named "default.css" will overwrite the builtin "default.css". |
---|
159 | html_static_path = ['_static'] |
---|
160 | |
---|
161 | # Add any extra paths that contain custom files (such as robots.txt or |
---|
162 | # .htaccess) here, relative to this directory. These files are copied |
---|
163 | # directly to the root of the documentation. |
---|
164 | #html_extra_path = [] |
---|
165 | |
---|
166 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
---|
167 | # using the given strftime format. |
---|
168 | #html_last_updated_fmt = '%b %d, %Y' |
---|
169 | |
---|
170 | # If true, SmartyPants will be used to convert quotes and dashes to |
---|
171 | # typographically correct entities. |
---|
172 | #html_use_smartypants = True |
---|
173 | |
---|
174 | # Custom sidebar templates, maps document names to template names. |
---|
175 | #html_sidebars = {} |
---|
176 | |
---|
177 | # Additional templates that should be rendered to pages, maps page names to |
---|
178 | # template names. |
---|
179 | #html_additional_pages = {} |
---|
180 | |
---|
181 | # If false, no module index is generated. |
---|
182 | #html_domain_indices = True |
---|
183 | |
---|
184 | # If false, no index is generated. |
---|
185 | #html_use_index = True |
---|
186 | |
---|
187 | # If true, the index is split into individual pages for each letter. |
---|
188 | #html_split_index = False |
---|
189 | |
---|
190 | # If true, links to the reST sources are added to the pages. |
---|
191 | #html_show_sourcelink = True |
---|
192 | |
---|
193 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. |
---|
194 | #html_show_sphinx = True |
---|
195 | |
---|
196 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. |
---|
197 | #html_show_copyright = True |
---|
198 | |
---|
199 | # If true, an OpenSearch description file will be output, and all pages will |
---|
200 | # contain a <link> tag referring to it. The value of this option must be the |
---|
201 | # base URL from which the finished HTML is served. |
---|
202 | #html_use_opensearch = '' |
---|
203 | |
---|
204 | # This is the file name suffix for HTML files (e.g. ".xhtml"). |
---|
205 | #html_file_suffix = None |
---|
206 | |
---|
207 | # Language to be used for generating the HTML full-text search index. |
---|
208 | # Sphinx supports the following languages: |
---|
209 | # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' |
---|
210 | # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' |
---|
211 | #html_search_language = 'en' |
---|
212 | |
---|
213 | # A dictionary with options for the search language support, empty by default. |
---|
214 | # Now only 'ja' uses this config value |
---|
215 | #html_search_options = {'type': 'default'} |
---|
216 | |
---|
217 | # The name of a javascript file (relative to the configuration directory) that |
---|
218 | # implements a search results scorer. If empty, the default will be used. |
---|
219 | #html_search_scorer = 'scorer.js' |
---|
220 | |
---|
221 | # Output file base name for HTML help builder. |
---|
222 | htmlhelp_basename = 'igcmg_docdoc' |
---|
223 | |
---|
224 | # -- Options for LaTeX output --------------------------------------------- |
---|
225 | |
---|
226 | latex_elements = { |
---|
227 | # The paper size ('letterpaper' or 'a4paper'). |
---|
228 | #'papersize': 'letterpaper', |
---|
229 | |
---|
230 | # The font size ('10pt', '11pt' or '12pt'). |
---|
231 | #'pointsize': '10pt', |
---|
232 | |
---|
233 | # Additional stuff for the LaTeX preamble. |
---|
234 | #'preamble': '', |
---|
235 | |
---|
236 | # Latex figure (float) alignment |
---|
237 | #'figure_align': 'htbp', |
---|
238 | } |
---|
239 | |
---|
240 | # Grouping the document tree into LaTeX files. List of tuples |
---|
241 | # (source start file, target name, title, |
---|
242 | # author, documentclass [howto, manual, or own class]). |
---|
243 | latex_documents = [ |
---|
244 | (master_doc, 'igcmg_doc.tex', u'igcmg\\_doc Documentation', u'igcmg', 'manual'), |
---|
245 | ] |
---|
246 | |
---|
247 | # The name of an image file (relative to this directory) to place at the top of |
---|
248 | # the title page. |
---|
249 | #latex_logo = None |
---|
250 | |
---|
251 | # For "manual" documents, if this is true, then toplevel headings are parts, |
---|
252 | # not chapters. |
---|
253 | #latex_use_parts = False |
---|
254 | |
---|
255 | # If true, show page references after internal links. |
---|
256 | #latex_show_pagerefs = False |
---|
257 | |
---|
258 | # If true, show URL addresses after external links. |
---|
259 | #latex_show_urls = False |
---|
260 | |
---|
261 | # Documents to append as an appendix to all manuals. |
---|
262 | #latex_appendices = [] |
---|
263 | |
---|
264 | # If false, no module index is generated. |
---|
265 | #latex_domain_indices = True |
---|
266 | |
---|
267 | |
---|
268 | # -- Options for manual page output --------------------------------------- |
---|
269 | |
---|
270 | # One entry per manual page. List of tuples |
---|
271 | # (source start file, name, description, authors, manual section). |
---|
272 | man_pages = [ |
---|
273 | (master_doc, 'igcmg_doc', u'igcmg_doc Documentation', |
---|
274 | [author], 1) |
---|
275 | ] |
---|
276 | |
---|
277 | # If true, show URL addresses after external links. |
---|
278 | #man_show_urls = False |
---|
279 | |
---|
280 | |
---|
281 | # -- Options for Texinfo output ------------------------------------------- |
---|
282 | |
---|
283 | # Grouping the document tree into Texinfo files. List of tuples |
---|
284 | # (source start file, target name, title, author, |
---|
285 | # dir menu entry, description, category) |
---|
286 | texinfo_documents = [ |
---|
287 | (master_doc, 'igcmg_doc', u'igcmg_doc Documentation', |
---|
288 | author, 'igcmg_doc', 'One line description of project.', |
---|
289 | 'Miscellaneous'), |
---|
290 | ] |
---|
291 | |
---|
292 | # Documents to append as an appendix to all manuals. |
---|
293 | #texinfo_appendices = [] |
---|
294 | |
---|
295 | # If false, no module index is generated. |
---|
296 | #texinfo_domain_indices = True |
---|
297 | |
---|
298 | # How to display URL addresses: 'footnote', 'no', or 'inline'. |
---|
299 | #texinfo_show_urls = 'footnote' |
---|
300 | |
---|
301 | # If true, do not generate a @detailmenu in the "Top" node's menu. |
---|
302 | #texinfo_no_detailmenu = False |
---|
303 | |
---|
304 | |
---|
305 | # -- Options for Epub output ---------------------------------------------- |
---|
306 | |
---|
307 | # Bibliographic Dublin Core info. |
---|
308 | epub_title = project |
---|
309 | epub_author = author |
---|
310 | epub_publisher = author |
---|
311 | epub_copyright = copyright |
---|
312 | |
---|
313 | # The basename for the epub file. It defaults to the project name. |
---|
314 | #epub_basename = project |
---|
315 | |
---|
316 | # The HTML theme for the epub output. Since the default themes are not optimized |
---|
317 | # for small screen space, using the same theme for HTML and epub output is |
---|
318 | # usually not wise. This defaults to 'epub', a theme designed to save visual |
---|
319 | # space. |
---|
320 | #epub_theme = 'epub' |
---|
321 | |
---|
322 | # The language of the text. It defaults to the language option |
---|
323 | # or 'en' if the language is not set. |
---|
324 | #epub_language = '' |
---|
325 | |
---|
326 | # The scheme of the identifier. Typical schemes are ISBN or URL. |
---|
327 | #epub_scheme = '' |
---|
328 | |
---|
329 | # The unique identifier of the text. This can be a ISBN number |
---|
330 | # or the project homepage. |
---|
331 | #epub_identifier = '' |
---|
332 | |
---|
333 | # A unique identification for the text. |
---|
334 | #epub_uid = '' |
---|
335 | |
---|
336 | # A tuple containing the cover image and cover page html template filenames. |
---|
337 | #epub_cover = () |
---|
338 | |
---|
339 | # A sequence of (type, uri, title) tuples for the guide element of content.opf. |
---|
340 | #epub_guide = () |
---|
341 | |
---|
342 | # HTML files that should be inserted before the pages created by sphinx. |
---|
343 | # The format is a list of tuples containing the path and title. |
---|
344 | #epub_pre_files = [] |
---|
345 | |
---|
346 | # HTML files shat should be inserted after the pages created by sphinx. |
---|
347 | # The format is a list of tuples containing the path and title. |
---|
348 | #epub_post_files = [] |
---|
349 | |
---|
350 | # A list of files that should not be packed into the epub file. |
---|
351 | epub_exclude_files = ['search.html'] |
---|
352 | |
---|
353 | # The depth of the table of contents in toc.ncx. |
---|
354 | #epub_tocdepth = 3 |
---|
355 | |
---|
356 | # Allow duplicate toc entries. |
---|
357 | #epub_tocdup = True |
---|
358 | |
---|
359 | # Choose between 'default' and 'includehidden'. |
---|
360 | #epub_tocscope = 'default' |
---|
361 | |
---|
362 | # Fix unsupported image types using the Pillow. |
---|
363 | #epub_fix_images = False |
---|
364 | |
---|
365 | # Scale large images. |
---|
366 | #epub_max_image_width = 0 |
---|
367 | |
---|
368 | # How to display URL addresses: 'footnote', 'no', or 'inline'. |
---|
369 | #epub_show_urls = 'inline' |
---|
370 | |
---|
371 | # If false, no index is generated. |
---|
372 | #epub_use_index = True |
---|
373 | |
---|
374 | |
---|
375 | # Example configuration for intersphinx: refer to the Python standard library. |
---|
376 | intersphinx_mapping = {'https://docs.python.org/2': None} |
---|