conf.py revision cbfa26dc
1# -*- coding: utf-8 -*-
2#
3# CSIT report documentation build configuration file
4#
5# This file is execfile()d with the current directory set to its
6# containing dir.
7#
8# Note that not all possible configuration values are present in this
9# autogenerated file.
10#
11# All configuration values have a default; values that are commented out
12# serve to show the default.
13
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.
17#
18import os
19import sys
20
21sys.path.insert(0, os.path.abspath(u'.'))
22
23# -- General configuration ------------------------------------------------
24
25# If your documentation needs a minimal Sphinx version, state it here.
26#
27# needs_sphinx = '1.0'
28
29# Add any Sphinx extension module names here, as strings. They can be
30# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
31# ones.
32extensions = [u'sphinxcontrib.programoutput',
33              u'sphinx.ext.ifconfig']
34
35# Add any paths that contain templates here, relative to this directory.
36templates_path = [u'_templates']
37
38# The suffix(es) of source filenames.
39# You can specify multiple suffix as a list of string:
40#
41source_suffix = [u'.rst', u'.md']
42
43# The master toctree document.
44master_doc = u'index'
45
46# General information about the project.
47project = u'FD.io CSIT'
48copyright = u'2018, FD.io'
49author = u'FD.io CSIT'
50
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
53# built documents.
54#
55# The short X.Y version.
56#version = u''
57# The full version, including alpha/beta/rc tags.
58#release = u''
59
60# The language for content autogenerated by Sphinx. Refer to documentation
61# for a list of supported languages.
62#
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.
65language = u'en'
66
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
70exclude_patterns = [u'_build', u'Thumbs.db', u'.DS_Store']
71
72# The name of the Pygments (syntax highlighting) style to use.
73pygments_style = u'sphinx'
74
75# If true, `todo` and `todoList` produce output, else they produce nothing.
76todo_include_todos = False
77
78# -- Options for HTML output ----------------------------------------------
79
80# The theme to use for HTML and HTML Help pages.  See the documentation for
81# a list of builtin themes.
82#
83html_theme = u'sphinx_rtd_theme'
84
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
87# documentation.
88#
89# html_theme_options = {}
90
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".
94html_theme_path = [u'env/lib/python2.7/site-packages/sphinx_rtd_theme']
95
96# html_static_path = ['_build/_static']
97html_static_path = [u'../_tmp/src/_static']
98
99html_context = {
100    u'css_files': [
101        u'_static/theme_overrides.css',  # overrides for wide tables in RTD theme
102        ],
103    }
104
105# If false, no module index is generated.
106html_domain_indices = True
107
108# If false, no index is generated.
109html_use_index = True
110
111# If true, the index is split into individual pages for each letter.
112html_split_index = False
113