root / doc / source / conf.py @ ca345a18
History | View | Annotate | Download (6.2 kB)
1 | 51ce199a | Leonidas Poulopoulos | # -*- coding: utf-8 -*-
|
---|---|---|---|
2 | 51ce199a | Leonidas Poulopoulos | #
|
3 | 51ce199a | Leonidas Poulopoulos | # fod documentation build configuration file, created by
|
4 | 51ce199a | Leonidas Poulopoulos | # sphinx-quickstart on Wed Oct 16 17:20:20 2013.
|
5 | 51ce199a | Leonidas Poulopoulos | #
|
6 | 51ce199a | Leonidas Poulopoulos | # This file is execfile()d with the current directory set to its containing dir.
|
7 | 51ce199a | Leonidas Poulopoulos | #
|
8 | 51ce199a | Leonidas Poulopoulos | # Note that not all possible configuration values are present in this
|
9 | 51ce199a | Leonidas Poulopoulos | # autogenerated file.
|
10 | 51ce199a | Leonidas Poulopoulos | #
|
11 | 51ce199a | Leonidas Poulopoulos | # All configuration values have a default; values that are commented out
|
12 | 51ce199a | Leonidas Poulopoulos | # serve to show the default.
|
13 | 51ce199a | Leonidas Poulopoulos | |
14 | 51ce199a | Leonidas Poulopoulos | import sys, os |
15 | 51ce199a | Leonidas Poulopoulos | |
16 | 51ce199a | Leonidas Poulopoulos | # If extensions (or modules to document with autodoc) are in another directory,
|
17 | 51ce199a | Leonidas Poulopoulos | # add these directories to sys.path here. If the directory is relative to the
|
18 | 51ce199a | Leonidas Poulopoulos | # documentation root, use os.path.abspath to make it absolute, like shown here.
|
19 | 51ce199a | Leonidas Poulopoulos | #sys.path.append(os.path.abspath('.'))
|
20 | 51ce199a | Leonidas Poulopoulos | |
21 | 51ce199a | Leonidas Poulopoulos | # -- General configuration -----------------------------------------------------
|
22 | 51ce199a | Leonidas Poulopoulos | |
23 | 51ce199a | Leonidas Poulopoulos | # Add any Sphinx extension module names here, as strings. They can be extensions
|
24 | 51ce199a | Leonidas Poulopoulos | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
25 | 51ce199a | Leonidas Poulopoulos | extensions = [] |
26 | 51ce199a | Leonidas Poulopoulos | |
27 | 51ce199a | Leonidas Poulopoulos | # Add any paths that contain templates here, relative to this directory.
|
28 | 51ce199a | Leonidas Poulopoulos | templates_path = ['_templates']
|
29 | 51ce199a | Leonidas Poulopoulos | |
30 | 51ce199a | Leonidas Poulopoulos | # The suffix of source filenames.
|
31 | 51ce199a | Leonidas Poulopoulos | source_suffix = '.rst'
|
32 | 51ce199a | Leonidas Poulopoulos | |
33 | 51ce199a | Leonidas Poulopoulos | # The encoding of source files.
|
34 | 51ce199a | Leonidas Poulopoulos | #source_encoding = 'utf-8'
|
35 | 51ce199a | Leonidas Poulopoulos | |
36 | 51ce199a | Leonidas Poulopoulos | # The master toctree document.
|
37 | 51ce199a | Leonidas Poulopoulos | master_doc = 'index'
|
38 | 51ce199a | Leonidas Poulopoulos | |
39 | 51ce199a | Leonidas Poulopoulos | # General information about the project.
|
40 | 51ce199a | Leonidas Poulopoulos | project = u'fod'
|
41 | b7566dcc | Leonidas Poulopoulos | copyright = u'2014, Leonidas Poulopoulos (@leopoul), GRNET S.A'
|
42 | 51ce199a | Leonidas Poulopoulos | |
43 | 51ce199a | Leonidas Poulopoulos | # The version info for the project you're documenting, acts as replacement for
|
44 | 51ce199a | Leonidas Poulopoulos | # |version| and |release|, also used in various other places throughout the
|
45 | 51ce199a | Leonidas Poulopoulos | # built documents.
|
46 | 51ce199a | Leonidas Poulopoulos | #
|
47 | 51ce199a | Leonidas Poulopoulos | # The short X.Y version.
|
48 | ca345a18 | Leonidas Poulopoulos | version = '1.1.0'
|
49 | 51ce199a | Leonidas Poulopoulos | # The full version, including alpha/beta/rc tags.
|
50 | ca345a18 | Leonidas Poulopoulos | release = '1.1.0'
|
51 | 51ce199a | Leonidas Poulopoulos | |
52 | 51ce199a | Leonidas Poulopoulos | # The language for content autogenerated by Sphinx. Refer to documentation
|
53 | 51ce199a | Leonidas Poulopoulos | # for a list of supported languages.
|
54 | 51ce199a | Leonidas Poulopoulos | #language = None
|
55 | 51ce199a | Leonidas Poulopoulos | |
56 | 51ce199a | Leonidas Poulopoulos | # There are two options for replacing |today|: either, you set today to some
|
57 | 51ce199a | Leonidas Poulopoulos | # non-false value, then it is used:
|
58 | 51ce199a | Leonidas Poulopoulos | #today = ''
|
59 | 51ce199a | Leonidas Poulopoulos | # Else, today_fmt is used as the format for a strftime call.
|
60 | 51ce199a | Leonidas Poulopoulos | #today_fmt = '%B %d, %Y'
|
61 | 51ce199a | Leonidas Poulopoulos | |
62 | 51ce199a | Leonidas Poulopoulos | # List of documents that shouldn't be included in the build.
|
63 | 51ce199a | Leonidas Poulopoulos | #unused_docs = []
|
64 | 51ce199a | Leonidas Poulopoulos | |
65 | 51ce199a | Leonidas Poulopoulos | # List of directories, relative to source directory, that shouldn't be searched
|
66 | 51ce199a | Leonidas Poulopoulos | # for source files.
|
67 | 51ce199a | Leonidas Poulopoulos | exclude_trees = [] |
68 | 51ce199a | Leonidas Poulopoulos | |
69 | 51ce199a | Leonidas Poulopoulos | # The reST default role (used for this markup: `text`) to use for all documents.
|
70 | 51ce199a | Leonidas Poulopoulos | #default_role = None
|
71 | 51ce199a | Leonidas Poulopoulos | |
72 | 51ce199a | Leonidas Poulopoulos | # If true, '()' will be appended to :func: etc. cross-reference text.
|
73 | 51ce199a | Leonidas Poulopoulos | #add_function_parentheses = True
|
74 | 51ce199a | Leonidas Poulopoulos | |
75 | 51ce199a | Leonidas Poulopoulos | # If true, the current module name will be prepended to all description
|
76 | 51ce199a | Leonidas Poulopoulos | # unit titles (such as .. function::).
|
77 | 51ce199a | Leonidas Poulopoulos | #add_module_names = True
|
78 | 51ce199a | Leonidas Poulopoulos | |
79 | 51ce199a | Leonidas Poulopoulos | # If true, sectionauthor and moduleauthor directives will be shown in the
|
80 | 51ce199a | Leonidas Poulopoulos | # output. They are ignored by default.
|
81 | 51ce199a | Leonidas Poulopoulos | #show_authors = False
|
82 | 51ce199a | Leonidas Poulopoulos | |
83 | 51ce199a | Leonidas Poulopoulos | # The name of the Pygments (syntax highlighting) style to use.
|
84 | 51ce199a | Leonidas Poulopoulos | pygments_style = 'sphinx'
|
85 | 51ce199a | Leonidas Poulopoulos | |
86 | 51ce199a | Leonidas Poulopoulos | # A list of ignored prefixes for module index sorting.
|
87 | 51ce199a | Leonidas Poulopoulos | #modindex_common_prefix = []
|
88 | 51ce199a | Leonidas Poulopoulos | |
89 | 51ce199a | Leonidas Poulopoulos | |
90 | 51ce199a | Leonidas Poulopoulos | # -- Options for HTML output ---------------------------------------------------
|
91 | 51ce199a | Leonidas Poulopoulos | |
92 | 51ce199a | Leonidas Poulopoulos | # The theme to use for HTML and HTML Help pages. Major themes that come with
|
93 | 51ce199a | Leonidas Poulopoulos | # Sphinx are currently 'default' and 'sphinxdoc'.
|
94 | 51ce199a | Leonidas Poulopoulos | html_theme = 'default'
|
95 | 51ce199a | Leonidas Poulopoulos | |
96 | 51ce199a | Leonidas Poulopoulos | # Theme options are theme-specific and customize the look and feel of a theme
|
97 | 51ce199a | Leonidas Poulopoulos | # further. For a list of options available for each theme, see the
|
98 | 51ce199a | Leonidas Poulopoulos | # documentation.
|
99 | 51ce199a | Leonidas Poulopoulos | #html_theme_options = {}
|
100 | 51ce199a | Leonidas Poulopoulos | |
101 | 51ce199a | Leonidas Poulopoulos | # Add any paths that contain custom themes here, relative to this directory.
|
102 | 51ce199a | Leonidas Poulopoulos | #html_theme_path = []
|
103 | 51ce199a | Leonidas Poulopoulos | |
104 | 51ce199a | Leonidas Poulopoulos | # The name for this set of Sphinx documents. If None, it defaults to
|
105 | 51ce199a | Leonidas Poulopoulos | # "<project> v<release> documentation".
|
106 | 51ce199a | Leonidas Poulopoulos | #html_title = None
|
107 | 51ce199a | Leonidas Poulopoulos | |
108 | 51ce199a | Leonidas Poulopoulos | # A shorter title for the navigation bar. Default is the same as html_title.
|
109 | 51ce199a | Leonidas Poulopoulos | #html_short_title = None
|
110 | 51ce199a | Leonidas Poulopoulos | |
111 | 51ce199a | Leonidas Poulopoulos | # The name of an image file (relative to this directory) to place at the top
|
112 | 51ce199a | Leonidas Poulopoulos | # of the sidebar.
|
113 | 51ce199a | Leonidas Poulopoulos | #html_logo = None
|
114 | 51ce199a | Leonidas Poulopoulos | |
115 | 51ce199a | Leonidas Poulopoulos | # The name of an image file (within the static path) to use as favicon of the
|
116 | 51ce199a | Leonidas Poulopoulos | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
117 | 51ce199a | Leonidas Poulopoulos | # pixels large.
|
118 | 51ce199a | Leonidas Poulopoulos | #html_favicon = None
|
119 | 51ce199a | Leonidas Poulopoulos | |
120 | 51ce199a | Leonidas Poulopoulos | # Add any paths that contain custom static files (such as style sheets) here,
|
121 | 51ce199a | Leonidas Poulopoulos | # relative to this directory. They are copied after the builtin static files,
|
122 | 51ce199a | Leonidas Poulopoulos | # so a file named "default.css" will overwrite the builtin "default.css".
|
123 | 51ce199a | Leonidas Poulopoulos | html_static_path = ['_static']
|
124 | 51ce199a | Leonidas Poulopoulos | |
125 | 51ce199a | Leonidas Poulopoulos | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
126 | 51ce199a | Leonidas Poulopoulos | # using the given strftime format.
|
127 | 51ce199a | Leonidas Poulopoulos | #html_last_updated_fmt = '%b %d, %Y'
|
128 | 51ce199a | Leonidas Poulopoulos | |
129 | 51ce199a | Leonidas Poulopoulos | # If true, SmartyPants will be used to convert quotes and dashes to
|
130 | 51ce199a | Leonidas Poulopoulos | # typographically correct entities.
|
131 | 51ce199a | Leonidas Poulopoulos | #html_use_smartypants = True
|
132 | 51ce199a | Leonidas Poulopoulos | |
133 | 51ce199a | Leonidas Poulopoulos | # Custom sidebar templates, maps document names to template names.
|
134 | 51ce199a | Leonidas Poulopoulos | #html_sidebars = {}
|
135 | 51ce199a | Leonidas Poulopoulos | |
136 | 51ce199a | Leonidas Poulopoulos | # Additional templates that should be rendered to pages, maps page names to
|
137 | 51ce199a | Leonidas Poulopoulos | # template names.
|
138 | 51ce199a | Leonidas Poulopoulos | #html_additional_pages = {}
|
139 | 51ce199a | Leonidas Poulopoulos | |
140 | 51ce199a | Leonidas Poulopoulos | # If false, no module index is generated.
|
141 | 51ce199a | Leonidas Poulopoulos | #html_use_modindex = True
|
142 | 51ce199a | Leonidas Poulopoulos | |
143 | 51ce199a | Leonidas Poulopoulos | # If false, no index is generated.
|
144 | 51ce199a | Leonidas Poulopoulos | #html_use_index = True
|
145 | 51ce199a | Leonidas Poulopoulos | |
146 | 51ce199a | Leonidas Poulopoulos | # If true, the index is split into individual pages for each letter.
|
147 | 51ce199a | Leonidas Poulopoulos | #html_split_index = False
|
148 | 51ce199a | Leonidas Poulopoulos | |
149 | 51ce199a | Leonidas Poulopoulos | # If true, links to the reST sources are added to the pages.
|
150 | 51ce199a | Leonidas Poulopoulos | #html_show_sourcelink = True
|
151 | 51ce199a | Leonidas Poulopoulos | |
152 | 51ce199a | Leonidas Poulopoulos | # If true, an OpenSearch description file will be output, and all pages will
|
153 | 51ce199a | Leonidas Poulopoulos | # contain a <link> tag referring to it. The value of this option must be the
|
154 | 51ce199a | Leonidas Poulopoulos | # base URL from which the finished HTML is served.
|
155 | 51ce199a | Leonidas Poulopoulos | #html_use_opensearch = ''
|
156 | 51ce199a | Leonidas Poulopoulos | |
157 | 51ce199a | Leonidas Poulopoulos | # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
|
158 | 51ce199a | Leonidas Poulopoulos | #html_file_suffix = ''
|
159 | 51ce199a | Leonidas Poulopoulos | |
160 | 51ce199a | Leonidas Poulopoulos | # Output file base name for HTML help builder.
|
161 | 51ce199a | Leonidas Poulopoulos | htmlhelp_basename = 'foddoc'
|
162 | 51ce199a | Leonidas Poulopoulos | |
163 | 51ce199a | Leonidas Poulopoulos | |
164 | 51ce199a | Leonidas Poulopoulos | # -- Options for LaTeX output --------------------------------------------------
|
165 | 51ce199a | Leonidas Poulopoulos | |
166 | 51ce199a | Leonidas Poulopoulos | # The paper size ('letter' or 'a4').
|
167 | 51ce199a | Leonidas Poulopoulos | #latex_paper_size = 'letter'
|
168 | 51ce199a | Leonidas Poulopoulos | |
169 | 51ce199a | Leonidas Poulopoulos | # The font size ('10pt', '11pt' or '12pt').
|
170 | 51ce199a | Leonidas Poulopoulos | #latex_font_size = '10pt'
|
171 | 51ce199a | Leonidas Poulopoulos | |
172 | 51ce199a | Leonidas Poulopoulos | # Grouping the document tree into LaTeX files. List of tuples
|
173 | 51ce199a | Leonidas Poulopoulos | # (source start file, target name, title, author, documentclass [howto/manual]).
|
174 | 51ce199a | Leonidas Poulopoulos | latex_documents = [ |
175 | 51ce199a | Leonidas Poulopoulos | ('index', 'fod.tex', u'fod Documentation', |
176 | 51ce199a | Leonidas Poulopoulos | u'Leonidas Poulopoulos', 'manual'), |
177 | 51ce199a | Leonidas Poulopoulos | ] |
178 | 51ce199a | Leonidas Poulopoulos | |
179 | 51ce199a | Leonidas Poulopoulos | # The name of an image file (relative to this directory) to place at the top of
|
180 | 51ce199a | Leonidas Poulopoulos | # the title page.
|
181 | 51ce199a | Leonidas Poulopoulos | #latex_logo = None
|
182 | 51ce199a | Leonidas Poulopoulos | |
183 | 51ce199a | Leonidas Poulopoulos | # For "manual" documents, if this is true, then toplevel headings are parts,
|
184 | 51ce199a | Leonidas Poulopoulos | # not chapters.
|
185 | 51ce199a | Leonidas Poulopoulos | #latex_use_parts = False
|
186 | 51ce199a | Leonidas Poulopoulos | |
187 | 51ce199a | Leonidas Poulopoulos | # Additional stuff for the LaTeX preamble.
|
188 | 51ce199a | Leonidas Poulopoulos | #latex_preamble = ''
|
189 | 51ce199a | Leonidas Poulopoulos | |
190 | 51ce199a | Leonidas Poulopoulos | # Documents to append as an appendix to all manuals.
|
191 | 51ce199a | Leonidas Poulopoulos | #latex_appendices = []
|
192 | 51ce199a | Leonidas Poulopoulos | |
193 | 51ce199a | Leonidas Poulopoulos | # If false, no module index is generated.
|
194 | 51ce199a | Leonidas Poulopoulos | #latex_use_modindex = True |