1 # -*- coding: utf-8 -*-
3 # CSIT documentation build configuration file, created by
4 # sphinx-quickstart on Tue Nov 8 10:19:40 2016.
6 # This file is execfile()d with the current directory set to its
9 # Note that not all possible configuration values are present in this
12 # All configuration values have a default; values that are commented out
13 # serve to show the default.
15 # If extensions (or modules to document with autodoc) are in another directory,
16 # add these directories to sys.path here. If the directory is relative to the
17 # documentation root, use os.path.abspath to make it absolute, like shown here.
22 sys.path.insert(0, os.path.abspath(u"."))
24 # -- General configuration ------------------------------------------------
26 # If your documentation needs a minimal Sphinx version, state it here.
28 # needs_sphinx = '1.0'
30 # Add any Sphinx extension module names here, as strings. They can be
31 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
34 u"sphinx.ext.autodoc",
35 u"sphinx.ext.doctest",
36 u"sphinxcontrib_robotdoc"
39 # Add any paths that contain templates here, relative to this directory.
40 templates_path = [u"_templates"]
42 # The suffix(es) of source file names.
43 # You can specify multiple suffix as a list of string:
45 source_suffix = [u".rst", u".md"]
47 # The master toctree document.
50 # General information about the project.
51 project = u"FD.io CSIT"
52 copyright = u"2021, FD.io"
53 author = u'FD.io CSIT'
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
59 # The short X.Y version.
61 # The full version, including alpha/beta/rc tags.
64 # The language for content autogenerated by Sphinx. Refer to documentation
65 # for a list of supported languages.
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.
71 # There are two options for replacing |today|: either, you set today to some
72 # non-false value, then it is used:
76 # Else, today_fmt is used as the format for a strftime call.
78 # today_fmt = '%B %d, %Y'
80 # List of patterns, relative to source directory, that match files and
81 # directories to ignore when looking for source files.
82 # This patterns also effect to html_static_path and html_extra_path
83 exclude_patterns = [u"_build", u"Thumbs.db", u".DS_Store"]
85 # The reST default role (used for this markup: `text`) to use for all
90 # If true, '()' will be appended to :func: etc. cross-reference text.
92 # add_function_parentheses = True
94 # If true, the current module name will be prepended to all description
95 # unit titles (such as .. function::).
97 # add_module_names = True
99 # If true, sectionauthor and moduleauthor directives will be shown in the
100 # output. They are ignored by default.
102 # show_authors = False
104 # The name of the Pygments (syntax highlighting) style to use.
105 pygments_style = u"sphinx"
107 # If true, `todo` and `todoList` produce output, else they produce nothing.
108 todo_include_todos = False
111 # -- Options for HTML output ----------------------------------------------
113 # The theme to use for HTML and HTML Help pages. See the documentation for
114 # a list of builtin themes.
116 # html_theme =u"alabaster"
117 html_theme = u"sphinx_rtd_theme"
119 # Theme options are theme-specific and customize the look and feel of a theme
120 # further. For a list of options available for each theme, see the
123 html_theme_options = {
124 u'canonical_url': u'',
125 u'analytics_id': u'',
127 u'display_version': True,
128 u'prev_next_buttons_location': u'bottom',
129 u'style_external_links': False,
131 u'collapse_navigation': True,
132 u'sticky_navigation': True,
133 u'navigation_depth': 3,
134 u'includehidden': True,
135 u'titles_only': False
138 # Add any paths that contain custom themes here, relative to this directory.
139 html_theme_path = [u'env/lib/python3.8/site-packages/sphinx_rtd_theme']
141 # The name for this set of Sphinx documents.
142 # "<project> v<release> documentation" by default.
144 html_title = u"CSIT Documentation"
146 # A shorter title for the navigation bar. Default is the same as html_title.
148 html_short_title = u"CSIT"
150 # The name of an image file (relative to this directory) to use as a favicon of
151 # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
154 # html_favicon = None
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 = [u"_static"]
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.
165 # html_extra_path = []
167 # If not None, a 'Last updated on:' timestamp is inserted at every page
168 # bottom, using the given strftime format.
169 # The empty string is equivalent to '%b %d, %Y'.
171 # html_last_updated_fmt = None
173 # If true, SmartyPants will be used to convert quotes and dashes to
174 # typographically correct entities.
176 # html_use_smartypants = True
178 # Custom sidebar templates, maps document names to template names.
184 # Additional templates that should be rendered to pages, maps page names to
187 # html_additional_pages = {}
189 # If false, no module index is generated.
190 html_domain_indices = True
192 # If false, no index is generated.
193 html_use_index = True
195 # If true, the index is split into individual pages for each letter.
196 html_split_index = False
198 # If true, links to the reST sources are added to the pages.
199 html_show_sourcelink = True
201 # Output file base name for HTML help builder.
202 htmlhelp_basename = u"csitdoc"
204 # -- Options for LaTeX output ---------------------------------------------
207 # The paper size ('letterpaper' or 'a4paper').
209 # 'papersize': 'letterpaper',
211 # The font size ('10pt', '11pt' or '12pt').
213 # 'pointsize': '10pt',
215 # Additional stuff for the LaTeX preamble.
219 # Latex figure (float) alignment
221 # 'figure_align': 'htbp',
224 # Grouping the document tree into LaTeX files. List of tuples
225 # (source start file, target name, title,
226 # author, documentclass [howto, manual, or own class]).
228 (master_doc, u"CSIT.tex", u"CSIT Documentation", u"CSIT", u"manual"),
231 # The name of an image file (relative to this directory) to place at the top of
236 # For "manual" documents, if this is true, then toplevel headings are parts,
239 # latex_use_parts = False
241 # If true, show page references after internal links.
243 # latex_show_pagerefs = False
245 # If true, show URL addresses after external links.
247 # latex_show_urls = False
249 # Documents to append as an appendix to all manuals.
251 # latex_appendices = []
253 # It false, will not define \strong, \code, itleref, \crossref ... but only
254 # \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
257 # latex_keep_old_macro_names = True
259 # If false, no module index is generated.
261 # latex_domain_indices = True
264 # -- Options for manual page output ---------------------------------------
266 # One entry per manual page. List of tuples
267 # (source start file, name, description, authors, manual section).
269 (master_doc, u"CSIT", u"CSIT Documentation", [author], 1)
272 # If true, show URL addresses after external links.
274 # man_show_urls = False
277 # -- Options for Texinfo output -------------------------------------------
279 # Grouping the document tree into Texinfo files. List of tuples
280 # (source start file, target name, title, author,
281 # dir menu entry, description, category)
282 texinfo_documents = [
283 (master_doc, u"CSIT", u"CSIT Documentation",
284 author, u"CSIT", u"One line description of project.",
288 # Documents to append as an appendix to all manuals.
290 # texinfo_appendices = []
292 # If false, no module index is generated.
294 # texinfo_domain_indices = True
296 # How to display URL addresses: 'footnote', 'no', or 'inline'.
298 # texinfo_show_urls = 'footnote'
300 # If true, do not generate a @detailmenu in the "Top" node's menu.
302 # texinfo_no_detailmenu = False