1 # -*- coding: utf-8 -*-
3 # CSIT report documentation build configuration file
5 # This file is execfile()d with the current directory set to its
8 # Note that not all possible configuration values are present in this
11 # All configuration values have a default; values that are commented out
12 # serve to show the default.
14 # If extensions (or modules to document with autodoc) are in another directory,
15 # add these directories to sys.path here. If the directory is relative to the
16 # documentation root, use os.path.abspath to make it absolute, like shown here.
21 sys.path.insert(0, os.path.abspath(u'.'))
23 # -- General configuration ------------------------------------------------
25 # If your documentation needs a minimal Sphinx version, state it here.
27 # needs_sphinx = '1.0'
29 # Add any Sphinx extension module names here, as strings. They can be
30 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
32 extensions = [u'sphinxcontrib.programoutput',
33 u'sphinx.ext.ifconfig']
35 # Add any paths that contain templates here, relative to this directory.
36 templates_path = [u'_templates']
38 # The suffix(es) of source filenames.
39 # You can specify multiple suffix as a list of string:
41 source_suffix = [u'.rst', u'.md']
43 # The master toctree document.
46 # General information about the project.
47 project = u'FD.io CSIT'
48 copyright = u'2020, FD.io'
49 author = u'FD.io CSIT'
51 # The version info for the project you're documenting, acts as replacement for
52 # |version| and |release|, also used in various other places throughout the
55 # The short X.Y version.
57 # The full version, including alpha/beta/rc tags.
60 # The language for content autogenerated by Sphinx. Refer to documentation
61 # for a list of supported languages.
63 # This is also used if you do content translation via gettext catalogs.
64 # Usually you set "language" from the command line for these cases.
67 # List of patterns, relative to source directory, that match files and
68 # directories to ignore when looking for source files.
69 # This patterns also effect to html_static_path and html_extra_path
70 exclude_patterns = [u'_build', u'Thumbs.db', u'.DS_Store']
72 # The name of the Pygments (syntax highlighting) style to use.
73 pygments_style = u'sphinx'
75 # If true, `todo` and `todoList` produce output, else they produce nothing.
76 todo_include_todos = False
78 # -- Options for HTML output ----------------------------------------------
80 # The theme to use for HTML and HTML Help pages. See the documentation for
81 # a list of builtin themes.
83 html_theme = u'sphinx_rtd_theme'
85 # Theme options are theme-specific and customize the look and feel of a theme
86 # further. For a list of options available for each theme, see the
89 # html_theme_options = {}
91 # Add any paths that contain custom static files (such as style sheets) here,
92 # relative to this directory. They are copied after the builtin static files,
93 # so a file named "default.css" will overwrite the builtin "default.css".
94 html_theme_path = [u'env/lib/python3.6/site-packages/sphinx_rtd_theme']
96 # html_static_path = ['_build/_static']
97 html_static_path = [u'../_tmp/src/_static']
101 # overrides for wide tables in RTD theme
102 u'_static/theme_overrides.css',
106 # If false, no module index is generated.
107 html_domain_indices = True
109 # If false, no index is generated.
110 html_use_index = True
112 # If true, the index is split into individual pages for each letter.
113 html_split_index = False