root / docs / conf.py @ be350355
History | View | Annotate | Download (6.7 kB)
1 | be350355 | John Giannelos | import sys, os |
---|---|---|---|
2 | be350355 | John Giannelos | |
3 | be350355 | John Giannelos | extensions = [] |
4 | be350355 | John Giannelos | |
5 | be350355 | John Giannelos | # Add any paths that contain templates here, relative to this directory.
|
6 | be350355 | John Giannelos | templates_path = ['_templates']
|
7 | be350355 | John Giannelos | |
8 | be350355 | John Giannelos | # The suffix of source filenames.
|
9 | be350355 | John Giannelos | source_suffix = '.rst'
|
10 | be350355 | John Giannelos | |
11 | be350355 | John Giannelos | # The encoding of source files.
|
12 | be350355 | John Giannelos | #source_encoding = 'utf-8-sig'
|
13 | be350355 | John Giannelos | |
14 | be350355 | John Giannelos | # The master toctree document.
|
15 | be350355 | John Giannelos | master_doc = 'index'
|
16 | be350355 | John Giannelos | |
17 | be350355 | John Giannelos | # General information about the project.
|
18 | be350355 | John Giannelos | project = u'snf-occi'
|
19 | be350355 | John Giannelos | copyright = u'2012, GRNET'
|
20 | be350355 | John Giannelos | |
21 | be350355 | John Giannelos | # The version info for the project you're documenting, acts as replacement for
|
22 | be350355 | John Giannelos | # |version| and |release|, also used in various other places throughout the
|
23 | be350355 | John Giannelos | # built documents.
|
24 | be350355 | John Giannelos | #
|
25 | be350355 | John Giannelos | # The short X.Y version.
|
26 | be350355 | John Giannelos | version = '0.1'
|
27 | be350355 | John Giannelos | # The full version, including alpha/beta/rc tags.
|
28 | be350355 | John Giannelos | release = '0.1'
|
29 | be350355 | John Giannelos | |
30 | be350355 | John Giannelos | # The language for content autogenerated by Sphinx. Refer to documentation
|
31 | be350355 | John Giannelos | # for a list of supported languages.
|
32 | be350355 | John Giannelos | #language = None
|
33 | be350355 | John Giannelos | |
34 | be350355 | John Giannelos | # There are two options for replacing |today|: either, you set today to some
|
35 | be350355 | John Giannelos | # non-false value, then it is used:
|
36 | be350355 | John Giannelos | #today = ''
|
37 | be350355 | John Giannelos | # Else, today_fmt is used as the format for a strftime call.
|
38 | be350355 | John Giannelos | #today_fmt = '%B %d, %Y'
|
39 | be350355 | John Giannelos | |
40 | be350355 | John Giannelos | # List of patterns, relative to source directory, that match files and
|
41 | be350355 | John Giannelos | # directories to ignore when looking for source files.
|
42 | be350355 | John Giannelos | exclude_patterns = ['_build']
|
43 | be350355 | John Giannelos | |
44 | be350355 | John Giannelos | # The reST default role (used for this markup: `text`) to use for all documents.
|
45 | be350355 | John Giannelos | #default_role = None
|
46 | be350355 | John Giannelos | |
47 | be350355 | John Giannelos | # If true, '()' will be appended to :func: etc. cross-reference text.
|
48 | be350355 | John Giannelos | #add_function_parentheses = True
|
49 | be350355 | John Giannelos | |
50 | be350355 | John Giannelos | # If true, the current module name will be prepended to all description
|
51 | be350355 | John Giannelos | # unit titles (such as .. function::).
|
52 | be350355 | John Giannelos | #add_module_names = True
|
53 | be350355 | John Giannelos | |
54 | be350355 | John Giannelos | # If true, sectionauthor and moduleauthor directives will be shown in the
|
55 | be350355 | John Giannelos | # output. They are ignored by default.
|
56 | be350355 | John Giannelos | #show_authors = False
|
57 | be350355 | John Giannelos | |
58 | be350355 | John Giannelos | # The name of the Pygments (syntax highlighting) style to use.
|
59 | be350355 | John Giannelos | pygments_style = 'sphinx'
|
60 | be350355 | John Giannelos | |
61 | be350355 | John Giannelos | # A list of ignored prefixes for module index sorting.
|
62 | be350355 | John Giannelos | #modindex_common_prefix = []
|
63 | be350355 | John Giannelos | |
64 | be350355 | John Giannelos | |
65 | be350355 | John Giannelos | # -- Options for HTML output ---------------------------------------------------
|
66 | be350355 | John Giannelos | |
67 | be350355 | John Giannelos | # The theme to use for HTML and HTML Help pages. See the documentation for
|
68 | be350355 | John Giannelos | # a list of builtin themes.
|
69 | be350355 | John Giannelos | html_theme = 'nature'
|
70 | be350355 | John Giannelos | |
71 | be350355 | John Giannelos | # Theme options are theme-specific and customize the look and feel of a theme
|
72 | be350355 | John Giannelos | # further. For a list of options available for each theme, see the
|
73 | be350355 | John Giannelos | # documentation.
|
74 | be350355 | John Giannelos | #html_theme_options = {}
|
75 | be350355 | John Giannelos | |
76 | be350355 | John Giannelos | # Add any paths that contain custom themes here, relative to this directory.
|
77 | be350355 | John Giannelos | #html_theme_path = []
|
78 | be350355 | John Giannelos | |
79 | be350355 | John Giannelos | # The name for this set of Sphinx documents. If None, it defaults to
|
80 | be350355 | John Giannelos | # "<project> v<release> documentation".
|
81 | be350355 | John Giannelos | #html_title = None
|
82 | be350355 | John Giannelos | |
83 | be350355 | John Giannelos | # A shorter title for the navigation bar. Default is the same as html_title.
|
84 | be350355 | John Giannelos | #html_short_title = None
|
85 | be350355 | John Giannelos | |
86 | be350355 | John Giannelos | # The name of an image file (relative to this directory) to place at the top
|
87 | be350355 | John Giannelos | # of the sidebar.
|
88 | be350355 | John Giannelos | #html_logo = None
|
89 | be350355 | John Giannelos | |
90 | be350355 | John Giannelos | # The name of an image file (within the static path) to use as favicon of the
|
91 | be350355 | John Giannelos | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
92 | be350355 | John Giannelos | # pixels large.
|
93 | be350355 | John Giannelos | #html_favicon = None
|
94 | be350355 | John Giannelos | |
95 | be350355 | John Giannelos | # Add any paths that contain custom static files (such as style sheets) here,
|
96 | be350355 | John Giannelos | # relative to this directory. They are copied after the builtin static files,
|
97 | be350355 | John Giannelos | # so a file named "default.css" will overwrite the builtin "default.css".
|
98 | be350355 | John Giannelos | html_static_path = ['_static']
|
99 | be350355 | John Giannelos | |
100 | be350355 | John Giannelos | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
101 | be350355 | John Giannelos | # using the given strftime format.
|
102 | be350355 | John Giannelos | #html_last_updated_fmt = '%b %d, %Y'
|
103 | be350355 | John Giannelos | |
104 | be350355 | John Giannelos | # If true, SmartyPants will be used to convert quotes and dashes to
|
105 | be350355 | John Giannelos | # typographically correct entities.
|
106 | be350355 | John Giannelos | #html_use_smartypants = True
|
107 | be350355 | John Giannelos | |
108 | be350355 | John Giannelos | # Custom sidebar templates, maps document names to template names.
|
109 | be350355 | John Giannelos | #html_sidebars = {}
|
110 | be350355 | John Giannelos | |
111 | be350355 | John Giannelos | # Additional templates that should be rendered to pages, maps page names to
|
112 | be350355 | John Giannelos | # template names.
|
113 | be350355 | John Giannelos | #html_additional_pages = {}
|
114 | be350355 | John Giannelos | |
115 | be350355 | John Giannelos | # If false, no module index is generated.
|
116 | be350355 | John Giannelos | #html_domain_indices = True
|
117 | be350355 | John Giannelos | |
118 | be350355 | John Giannelos | # If false, no index is generated.
|
119 | be350355 | John Giannelos | #html_use_index = True
|
120 | be350355 | John Giannelos | |
121 | be350355 | John Giannelos | # If true, the index is split into individual pages for each letter.
|
122 | be350355 | John Giannelos | #html_split_index = False
|
123 | be350355 | John Giannelos | |
124 | be350355 | John Giannelos | # If true, links to the reST sources are added to the pages.
|
125 | be350355 | John Giannelos | #html_show_sourcelink = True
|
126 | be350355 | John Giannelos | |
127 | be350355 | John Giannelos | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
128 | be350355 | John Giannelos | #html_show_sphinx = True
|
129 | be350355 | John Giannelos | |
130 | be350355 | John Giannelos | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
131 | be350355 | John Giannelos | #html_show_copyright = True
|
132 | be350355 | John Giannelos | |
133 | be350355 | John Giannelos | # If true, an OpenSearch description file will be output, and all pages will
|
134 | be350355 | John Giannelos | # contain a <link> tag referring to it. The value of this option must be the
|
135 | be350355 | John Giannelos | # base URL from which the finished HTML is served.
|
136 | be350355 | John Giannelos | #html_use_opensearch = ''
|
137 | be350355 | John Giannelos | |
138 | be350355 | John Giannelos | # This is the file name suffix for HTML files (e.g. ".xhtml").
|
139 | be350355 | John Giannelos | #html_file_suffix = None
|
140 | be350355 | John Giannelos | |
141 | be350355 | John Giannelos | # Output file base name for HTML help builder.
|
142 | be350355 | John Giannelos | htmlhelp_basename = 'snf-occidoc'
|
143 | be350355 | John Giannelos | |
144 | be350355 | John Giannelos | |
145 | be350355 | John Giannelos | # -- Options for LaTeX output --------------------------------------------------
|
146 | be350355 | John Giannelos | |
147 | be350355 | John Giannelos | latex_elements = { |
148 | be350355 | John Giannelos | # The paper size ('letterpaper' or 'a4paper').
|
149 | be350355 | John Giannelos | #'papersize': 'letterpaper',
|
150 | be350355 | John Giannelos | |
151 | be350355 | John Giannelos | # The font size ('10pt', '11pt' or '12pt').
|
152 | be350355 | John Giannelos | #'pointsize': '10pt',
|
153 | be350355 | John Giannelos | |
154 | be350355 | John Giannelos | # Additional stuff for the LaTeX preamble.
|
155 | be350355 | John Giannelos | #'preamble': '',
|
156 | be350355 | John Giannelos | } |
157 | be350355 | John Giannelos | |
158 | be350355 | John Giannelos | # Grouping the document tree into LaTeX files. List of tuples
|
159 | be350355 | John Giannelos | # (source start file, target name, title, author, documentclass [howto/manual]).
|
160 | be350355 | John Giannelos | latex_documents = [ |
161 | be350355 | John Giannelos | ('index', 'snf-occi.tex', u'snf-occi Documentation', |
162 | be350355 | John Giannelos | u'John Giannelos', 'manual'), |
163 | be350355 | John Giannelos | ] |
164 | be350355 | John Giannelos | |
165 | be350355 | John Giannelos | # The name of an image file (relative to this directory) to place at the top of
|
166 | be350355 | John Giannelos | # the title page.
|
167 | be350355 | John Giannelos | #latex_logo = None
|
168 | be350355 | John Giannelos | |
169 | be350355 | John Giannelos | # For "manual" documents, if this is true, then toplevel headings are parts,
|
170 | be350355 | John Giannelos | # not chapters.
|
171 | be350355 | John Giannelos | #latex_use_parts = False
|
172 | be350355 | John Giannelos | |
173 | be350355 | John Giannelos | # If true, show page references after internal links.
|
174 | be350355 | John Giannelos | #latex_show_pagerefs = False
|
175 | be350355 | John Giannelos | |
176 | be350355 | John Giannelos | # If true, show URL addresses after external links.
|
177 | be350355 | John Giannelos | #latex_show_urls = False
|
178 | be350355 | John Giannelos | |
179 | be350355 | John Giannelos | # Documents to append as an appendix to all manuals.
|
180 | be350355 | John Giannelos | #latex_appendices = []
|
181 | be350355 | John Giannelos | |
182 | be350355 | John Giannelos | # If false, no module index is generated.
|
183 | be350355 | John Giannelos | #latex_domain_indices = True
|
184 | be350355 | John Giannelos | |
185 | be350355 | John Giannelos | |
186 | be350355 | John Giannelos | # -- Options for manual page output --------------------------------------------
|
187 | be350355 | John Giannelos | |
188 | be350355 | John Giannelos | # One entry per manual page. List of tuples
|
189 | be350355 | John Giannelos | # (source start file, name, description, authors, manual section).
|
190 | be350355 | John Giannelos | man_pages = [ |
191 | be350355 | John Giannelos | ('index', 'snf-occi', u'snf-occi Documentation', |
192 | be350355 | John Giannelos | [u'John Giannelos'], 1) |
193 | be350355 | John Giannelos | ] |
194 | be350355 | John Giannelos | |
195 | be350355 | John Giannelos | # If true, show URL addresses after external links.
|
196 | be350355 | John Giannelos | #man_show_urls = False
|
197 | be350355 | John Giannelos | |
198 | be350355 | John Giannelos | |
199 | be350355 | John Giannelos | # -- Options for Texinfo output ------------------------------------------------
|
200 | be350355 | John Giannelos | |
201 | be350355 | John Giannelos | # Grouping the document tree into Texinfo files. List of tuples
|
202 | be350355 | John Giannelos | # (source start file, target name, title, author,
|
203 | be350355 | John Giannelos | # dir menu entry, description, category)
|
204 | be350355 | John Giannelos | texinfo_documents = [ |
205 | be350355 | John Giannelos | ('index', 'snf-occi', u'snf-occi Documentation', |
206 | be350355 | John Giannelos | u'John Giannelos', 'snf-occi', 'One line description of project.', |
207 | be350355 | John Giannelos | 'Miscellaneous'),
|
208 | be350355 | John Giannelos | ] |
209 | be350355 | John Giannelos | |
210 | be350355 | John Giannelos | # Documents to append as an appendix to all manuals.
|
211 | be350355 | John Giannelos | #texinfo_appendices = []
|
212 | be350355 | John Giannelos | |
213 | be350355 | John Giannelos | # If false, no module index is generated.
|
214 | be350355 | John Giannelos | #texinfo_domain_indices = True
|
215 | be350355 | John Giannelos | |
216 | be350355 | John Giannelos | # How to display URL addresses: 'footnote', 'no', or 'inline'.
|
217 | be350355 | John Giannelos | #texinfo_show_urls = 'footnote'
|
218 | be350355 | John Giannelos | |
219 | be350355 | John Giannelos | intersphinx_mapping = { |
220 | be350355 | John Giannelos | 'python': ('http://docs.python.org/', None), |
221 | be350355 | John Giannelos | 'django': ('https://docs.djangoproject.com/en/dev/', |
222 | be350355 | John Giannelos | 'https://docs.djangoproject.com/en/dev/_objects/')
|
223 | be350355 | John Giannelos | } |