|
0
|
1 # -*- coding: utf-8 -*-
|
|
|
2 #
|
|
|
3 # Orthanc documentation build configuration file, created by
|
|
|
4 # sphinx-quickstart on Mon Sep 7 08:47:47 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 import sphinx_bootstrap_theme
|
|
|
20
|
|
|
21 # If extensions (or modules to document with autodoc) are in another directory,
|
|
|
22 # add these directories to sys.path here. If the directory is relative to the
|
|
|
23 # documentation root, use os.path.abspath to make it absolute, like shown here.
|
|
|
24 #sys.path.insert(0, os.path.abspath('.'))
|
|
|
25
|
|
|
26 # -- General configuration ------------------------------------------------
|
|
|
27
|
|
|
28 # If your documentation needs a minimal Sphinx version, state it here.
|
|
|
29 #needs_sphinx = '1.0'
|
|
|
30
|
|
|
31 # Add any Sphinx extension module names here, as strings. They can be
|
|
|
32 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
|
33 # ones.
|
|
|
34 extensions = []
|
|
|
35
|
|
|
36 # Add any paths that contain templates here, relative to this directory.
|
|
|
37 templates_path = ['_templates']
|
|
|
38
|
|
|
39 # The suffix(es) of source filenames.
|
|
|
40 # You can specify multiple suffix as a list of string:
|
|
|
41 # source_suffix = ['.rst', '.md']
|
|
|
42 source_suffix = '.rst'
|
|
|
43
|
|
|
44 # The encoding of source files.
|
|
|
45 #source_encoding = 'utf-8-sig'
|
|
|
46
|
|
|
47 # The master toctree document.
|
|
|
48 master_doc = 'index'
|
|
|
49
|
|
|
50 # General information about the project.
|
|
|
51 project = u'Orthanc Book'
|
|
1
|
52 copyright = u'' # Copyright is set in "_templates/layout.html"
|
|
0
|
53 author = u''
|
|
|
54
|
|
|
55 # The version info for the project you're documenting, acts as replacement for
|
|
|
56 # |version| and |release|, also used in various other places throughout the
|
|
|
57 # built documents.
|
|
|
58 #
|
|
|
59 # The short X.Y version.
|
|
|
60 version = ''
|
|
|
61 # The full version, including alpha/beta/rc tags.
|
|
|
62 release = ''
|
|
|
63
|
|
|
64 # The language for content autogenerated by Sphinx. Refer to documentation
|
|
|
65 # for a list of supported languages.
|
|
|
66 #
|
|
|
67 # This is also used if you do content translation via gettext catalogs.
|
|
|
68 # Usually you set "language" from the command line for these cases.
|
|
|
69 language = None
|
|
|
70
|
|
|
71 # There are two options for replacing |today|: either, you set today to some
|
|
|
72 # non-false value, then it is used:
|
|
|
73 #today = ''
|
|
|
74 # Else, today_fmt is used as the format for a strftime call.
|
|
|
75 #today_fmt = '%B %d, %Y'
|
|
|
76
|
|
|
77 # List of patterns, relative to source directory, that match files and
|
|
|
78 # directories to ignore when looking for source files.
|
|
|
79 exclude_patterns = []
|
|
|
80
|
|
|
81 # The reST default role (used for this markup: `text`) to use for all
|
|
|
82 # documents.
|
|
|
83 #default_role = None
|
|
|
84
|
|
|
85 # If true, '()' will be appended to :func: etc. cross-reference text.
|
|
|
86 #add_function_parentheses = True
|
|
|
87
|
|
|
88 # If true, the current module name will be prepended to all description
|
|
|
89 # unit titles (such as .. function::).
|
|
|
90 #add_module_names = True
|
|
|
91
|
|
|
92 # If true, sectionauthor and moduleauthor directives will be shown in the
|
|
|
93 # output. They are ignored by default.
|
|
|
94 #show_authors = False
|
|
|
95
|
|
|
96 # The name of the Pygments (syntax highlighting) style to use.
|
|
|
97 pygments_style = 'sphinx'
|
|
|
98
|
|
|
99 # A list of ignored prefixes for module index sorting.
|
|
|
100 #modindex_common_prefix = []
|
|
|
101
|
|
|
102 # If true, keep warnings as "system message" paragraphs in the built documents.
|
|
|
103 #keep_warnings = False
|
|
|
104
|
|
|
105 # If true, `todo` and `todoList` produce output, else they produce nothing.
|
|
|
106 todo_include_todos = False
|
|
|
107
|
|
|
108
|
|
|
109 # -- Options for HTML output ----------------------------------------------
|
|
|
110
|
|
|
111 # The theme to use for HTML and HTML Help pages. See the documentation for
|
|
|
112 # a list of builtin themes.
|
|
|
113 #html_theme = 'alabaster'
|
|
|
114 html_theme = 'bootstrap'
|
|
|
115
|
|
|
116 # Theme options are theme-specific and customize the look and feel of a theme
|
|
|
117 # further. For a list of options available for each theme, see the
|
|
|
118 # documentation.
|
|
|
119 #html_theme_options = {}
|
|
|
120
|
|
|
121 html_theme_options = {
|
|
|
122 'bootswatch_theme' : 'united',
|
|
|
123 'navbar_pagenav': False,
|
|
|
124 'navbar_sidebarrel': False,
|
|
|
125 'navbar_site_name': 'Content',
|
|
|
126 }
|
|
|
127
|
|
|
128 # Add any paths that contain custom themes here, relative to this directory.
|
|
|
129 #html_theme_path = []
|
|
|
130 html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
|
|
|
131
|
|
|
132 # The name for this set of Sphinx documents. If None, it defaults to
|
|
|
133 # "<project> v<release> documentation".
|
|
|
134 #html_title = None
|
|
|
135
|
|
|
136 # A shorter title for the navigation bar. Default is the same as html_title.
|
|
|
137 #html_short_title = None
|
|
|
138
|
|
|
139 # The name of an image file (relative to this directory) to place at the top
|
|
|
140 # of the sidebar.
|
|
|
141 #html_logo = None
|
|
|
142 #html_logo = 'logo.png'
|
|
|
143
|
|
|
144 # The name of an image file (within the static path) to use as favicon of the
|
|
|
145 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
|
|
146 # pixels large.
|
|
|
147 #html_favicon = None
|
|
|
148
|
|
|
149 # Add any paths that contain custom static files (such as style sheets) here,
|
|
|
150 # relative to this directory. They are copied after the builtin static files,
|
|
|
151 # so a file named "default.css" will overwrite the builtin "default.css".
|
|
|
152 html_static_path = ['_static']
|
|
|
153
|
|
|
154 # Add any extra paths that contain custom files (such as robots.txt or
|
|
|
155 # .htaccess) here, relative to this directory. These files are copied
|
|
|
156 # directly to the root of the documentation.
|
|
|
157 #html_extra_path = []
|
|
|
158
|
|
|
159 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
|
|
160 # using the given strftime format.
|
|
|
161 #html_last_updated_fmt = '%b %d, %Y'
|
|
|
162
|
|
|
163 # If true, SmartyPants will be used to convert quotes and dashes to
|
|
|
164 # typographically correct entities.
|
|
|
165 #html_use_smartypants = True
|
|
|
166
|
|
|
167 # Custom sidebar templates, maps document names to template names.
|
|
|
168 #html_sidebars = {}
|
|
|
169
|
|
|
170 # Additional templates that should be rendered to pages, maps page names to
|
|
|
171 # template names.
|
|
|
172 #html_additional_pages = {}
|
|
|
173
|
|
|
174 # If false, no module index is generated.
|
|
|
175 #html_domain_indices = True
|
|
|
176
|
|
|
177 # If false, no index is generated.
|
|
|
178 #html_use_index = True
|
|
|
179
|
|
|
180 # If true, the index is split into individual pages for each letter.
|
|
|
181 #html_split_index = False
|
|
|
182
|
|
|
183 # If true, links to the reST sources are added to the pages.
|
|
|
184 #html_show_sourcelink = True
|
|
|
185 html_show_sourcelink = False
|
|
|
186
|
|
|
187 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
|
|
188 #html_show_sphinx = True
|
|
|
189
|
|
|
190 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
|
|
191 #html_show_copyright = True
|
|
|
192
|
|
|
193 # If true, an OpenSearch description file will be output, and all pages will
|
|
|
194 # contain a <link> tag referring to it. The value of this option must be the
|
|
|
195 # base URL from which the finished HTML is served.
|
|
|
196 #html_use_opensearch = ''
|
|
|
197
|
|
|
198 # This is the file name suffix for HTML files (e.g. ".xhtml").
|
|
|
199 #html_file_suffix = None
|
|
|
200
|
|
|
201 # Language to be used for generating the HTML full-text search index.
|
|
|
202 # Sphinx supports the following languages:
|
|
|
203 # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
|
|
|
204 # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
|
|
|
205 #html_search_language = 'en'
|
|
|
206
|
|
|
207 # A dictionary with options for the search language support, empty by default.
|
|
|
208 # Now only 'ja' uses this config value
|
|
|
209 #html_search_options = {'type': 'default'}
|
|
|
210
|
|
|
211 # The name of a javascript file (relative to the configuration directory) that
|
|
|
212 # implements a search results scorer. If empty, the default will be used.
|
|
|
213 #html_search_scorer = 'scorer.js'
|
|
|
214
|
|
|
215 # Output file base name for HTML help builder.
|
|
|
216 htmlhelp_basename = 'Orthancdoc'
|
|
|
217
|
|
|
218 # -- Options for LaTeX output ---------------------------------------------
|
|
|
219
|
|
|
220 latex_elements = {
|
|
|
221 # The paper size ('letterpaper' or 'a4paper').
|
|
|
222 #'papersize': 'letterpaper',
|
|
|
223
|
|
|
224 # The font size ('10pt', '11pt' or '12pt').
|
|
|
225 #'pointsize': '10pt',
|
|
|
226
|
|
|
227 # Additional stuff for the LaTeX preamble.
|
|
|
228 #'preamble': '',
|
|
|
229
|
|
|
230 # Latex figure (float) alignment
|
|
|
231 #'figure_align': 'htbp',
|
|
|
232 }
|
|
|
233
|
|
|
234 # Grouping the document tree into LaTeX files. List of tuples
|
|
|
235 # (source start file, target name, title,
|
|
|
236 # author, documentclass [howto, manual, or own class]).
|
|
|
237 latex_documents = [
|
|
|
238 (master_doc, 'Orthanc.tex', u'Orthanc Documentation',
|
|
|
239 u'Sebastien Jodogne', 'manual'),
|
|
|
240 ]
|
|
|
241
|
|
|
242 # The name of an image file (relative to this directory) to place at the top of
|
|
|
243 # the title page.
|
|
|
244 #latex_logo = None
|
|
|
245
|
|
|
246 # For "manual" documents, if this is true, then toplevel headings are parts,
|
|
|
247 # not chapters.
|
|
|
248 #latex_use_parts = False
|
|
|
249
|
|
|
250 # If true, show page references after internal links.
|
|
|
251 #latex_show_pagerefs = False
|
|
|
252
|
|
|
253 # If true, show URL addresses after external links.
|
|
|
254 #latex_show_urls = False
|
|
|
255
|
|
|
256 # Documents to append as an appendix to all manuals.
|
|
|
257 #latex_appendices = []
|
|
|
258
|
|
|
259 # If false, no module index is generated.
|
|
|
260 #latex_domain_indices = True
|
|
|
261
|
|
|
262
|
|
|
263 # -- Options for manual page output ---------------------------------------
|
|
|
264
|
|
|
265 # One entry per manual page. List of tuples
|
|
|
266 # (source start file, name, description, authors, manual section).
|
|
|
267 man_pages = [
|
|
|
268 (master_doc, 'orthanc', u'Orthanc Documentation',
|
|
|
269 [author], 1)
|
|
|
270 ]
|
|
|
271
|
|
|
272 # If true, show URL addresses after external links.
|
|
|
273 #man_show_urls = False
|
|
|
274
|
|
|
275
|
|
|
276 # -- Options for Texinfo output -------------------------------------------
|
|
|
277
|
|
|
278 # Grouping the document tree into Texinfo files. List of tuples
|
|
|
279 # (source start file, target name, title, author,
|
|
|
280 # dir menu entry, description, category)
|
|
|
281 texinfo_documents = [
|
|
|
282 (master_doc, 'Orthanc', u'Orthanc Documentation',
|
|
|
283 author, 'Orthanc', 'One line description of project.',
|
|
|
284 'Miscellaneous'),
|
|
|
285 ]
|
|
|
286
|
|
|
287 # Documents to append as an appendix to all manuals.
|
|
|
288 #texinfo_appendices = []
|
|
|
289
|
|
|
290 # If false, no module index is generated.
|
|
|
291 #texinfo_domain_indices = True
|
|
|
292
|
|
|
293 # How to display URL addresses: 'footnote', 'no', or 'inline'.
|
|
|
294 #texinfo_show_urls = 'footnote'
|
|
|
295
|
|
|
296 # If true, do not generate a @detailmenu in the "Top" node's menu.
|
|
|
297 #texinfo_no_detailmenu = False
|
