1 # -*- coding: utf-8 -*-
3 # CSIT 17.01 report documentation build configuration file, created by
4 # sphinx-quickstart on Sun Jan 15 09:49:36 2017.
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('.'))
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
35 # Add any paths that contain templates here, relative to this directory.
36 templates_path = ['_templates']
38 # The suffix(es) of source filenames.
39 # You can specify multiple suffix as a list of string:
41 source_suffix = ['.rst', '.md']
43 # The master toctree document.
46 # General information about the project.
48 copyright = u'2017, fd.io'
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 = ['_build', 'Thumbs.db', '.DS_Store']
72 # The name of the Pygments (syntax highlighting) style to use.
73 pygments_style = 'sphinx'
75 # If true, `todo` and `todoList` produce output, else they produce nothing.
76 todo_include_todos = False
78 #pdf_documents = [('index', u'rst2pdf', u'Sample rst2pdf doc', u'Your Name'),]
81 # -- Options for HTML output ----------------------------------------------
83 # The theme to use for HTML and HTML Help pages. See the documentation for
84 # a list of builtin themes.
86 html_theme = 'sphinx_rtd_theme'
88 # Theme options are theme-specific and customize the look and feel of a theme
89 # further. For a list of options available for each theme, see the
92 # html_theme_options = {}
94 # Add any paths that contain custom static files (such as style sheets) here,
95 # relative to this directory. They are copied after the builtin static files,
96 # so a file named "default.css" will overwrite the builtin "default.css".
97 html_theme_path = ['env/lib/python2.7/site-packages/sphinx_rtd_theme']
99 html_static_path = ['../../../docs/report/_static']
103 '_static/theme_overrides.css', # overrides for wide tables in RTD theme
107 # -- Options for HTMLHelp output ------------------------------------------
109 # Output file base name for HTML help builder.
110 htmlhelp_basename = u'CSIT 17.01 report'
112 # -- Options for LaTeX output ---------------------------------------------
115 # The paper size ('letterpaper' or 'a4paper').
117 # 'papersize': 'letterpaper',
119 # The font size ('10pt', '11pt' or '12pt').
121 # 'pointsize': '10pt',
123 # Additional stuff for the LaTeX preamble.
127 # Latex figure (float) alignment
129 # 'figure_align': 'htbp',
132 # Grouping the document tree into LaTeX files. List of tuples
133 # (source start file, target name, title,
134 # author, documentclass [howto, manual, or own class]).
136 (master_doc, 'CSIT1701report.tex', u'CSIT 17.01 report',
141 # -- Options for manual page output ---------------------------------------
143 # One entry per manual page. List of tuples
144 # (source start file, name, description, authors, manual section).
146 (master_doc, 'csit1701report', u'CSIT 17.01 report',
151 # -- Options for Texinfo output -------------------------------------------
153 # Grouping the document tree into Texinfo files. List of tuples
154 # (source start file, target name, title, author,
155 # dir menu entry, description, category)
156 texinfo_documents = [
157 (master_doc, 'CSIT1701report', u'CSIT 17.01 report',
158 author, 'CSIT1701report', 'One line description of project.',