--- /dev/null
+# -*- coding: utf-8 -*-\r
+#\r
+# Configuration file for the Sphinx documentation builder.\r
+#\r
+# This file does only contain a selection of the most common options. For a\r
+# full list see the documentation:\r
+# http://www.sphinx-doc.org/en/master/config\r
+\r
+# -- Path setup --------------------------------------------------------------\r
+\r
+# If extensions (or modules to document with autodoc) are in another directory,\r
+# add these directories to sys.path here. If the directory is relative to the\r
+# documentation root, use os.path.abspath to make it absolute, like shown here.\r
+#\r
+# import os\r
+# import sys\r
+# sys.path.insert(0, os.path.abspath('.'))\r
+\r
+\r
+# -- Project information -----------------------------------------------------\r
+\r
+project = u'Joy VUI'\r
+copyright = u'2019, Simon Forman'\r
+author = u'Simon Forman'\r
+\r
+# The short X.Y version\r
+version = u''\r
+# The full version, including alpha/beta/rc tags\r
+release = u'0.1'\r
+\r
+\r
+# -- General configuration ---------------------------------------------------\r
+\r
+# If your documentation needs a minimal Sphinx version, state it here.\r
+#\r
+# needs_sphinx = '1.0'\r
+\r
+# Add any Sphinx extension module names here, as strings. They can be\r
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom\r
+# ones.\r
+extensions = [\r
+ 'sphinx.ext.autodoc',\r
+ 'sphinx.ext.imgmath',\r
+ 'sphinx.ext.viewcode',\r
+]\r
+\r
+# Add any paths that contain templates here, relative to this directory.\r
+templates_path = ['_templates']\r
+\r
+# The suffix(es) of source filenames.\r
+# You can specify multiple suffix as a list of string:\r
+#\r
+# source_suffix = ['.rst', '.md']\r
+source_suffix = '.rst'\r
+\r
+# The master toctree document.\r
+master_doc = 'index'\r
+\r
+# The language for content autogenerated by Sphinx. Refer to documentation\r
+# for a list of supported languages.\r
+#\r
+# This is also used if you do content translation via gettext catalogs.\r
+# Usually you set "language" from the command line for these cases.\r
+language = None\r
+\r
+# List of patterns, relative to source directory, that match files and\r
+# directories to ignore when looking for source files.\r
+# This pattern also affects html_static_path and html_extra_path.\r
+exclude_patterns = []\r
+\r
+# The name of the Pygments (syntax highlighting) style to use.\r
+pygments_style = None\r
+\r
+\r
+# -- Options for HTML output -------------------------------------------------\r
+\r
+# The theme to use for HTML and HTML Help pages. See the documentation for\r
+# a list of builtin themes.\r
+#\r
+html_theme = 'alabaster'\r
+\r
+# Theme options are theme-specific and customize the look and feel of a theme\r
+# further. For a list of options available for each theme, see the\r
+# documentation.\r
+#\r
+# html_theme_options = {}\r
+\r
+# Add any paths that contain custom static files (such as style sheets) here,\r
+# relative to this directory. They are copied after the builtin static files,\r
+# so a file named "default.css" will overwrite the builtin "default.css".\r
+html_static_path = ['_static']\r
+\r
+# Custom sidebar templates, must be a dictionary that maps document names\r
+# to template names.\r
+#\r
+# The default sidebars (for documents that don't match any pattern) are\r
+# defined by theme itself. Builtin themes are using these templates by\r
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',\r
+# 'searchbox.html']``.\r
+#\r
+# html_sidebars = {}\r
+\r
+\r
+# -- Options for HTMLHelp output ---------------------------------------------\r
+\r
+# Output file base name for HTML help builder.\r
+htmlhelp_basename = 'JoyVUIdoc'\r
+\r
+\r
+# -- Options for LaTeX output ------------------------------------------------\r
+\r
+latex_elements = {\r
+ # The paper size ('letterpaper' or 'a4paper').\r
+ #\r
+ # 'papersize': 'letterpaper',\r
+\r
+ # The font size ('10pt', '11pt' or '12pt').\r
+ #\r
+ # 'pointsize': '10pt',\r
+\r
+ # Additional stuff for the LaTeX preamble.\r
+ #\r
+ # 'preamble': '',\r
+\r
+ # Latex figure (float) alignment\r
+ #\r
+ # 'figure_align': 'htbp',\r
+}\r
+\r
+# Grouping the document tree into LaTeX files. List of tuples\r
+# (source start file, target name, title,\r
+# author, documentclass [howto, manual, or own class]).\r
+latex_documents = [\r
+ (master_doc, 'JoyVUI.tex', u'Joy VUI Documentation',\r
+ u'Simon Forman', 'manual'),\r
+]\r
+\r
+\r
+# -- Options for manual page output ------------------------------------------\r
+\r
+# One entry per manual page. List of tuples\r
+# (source start file, name, description, authors, manual section).\r
+man_pages = [\r
+ (master_doc, 'joyvui', u'Joy VUI Documentation',\r
+ [author], 1)\r
+]\r
+\r
+\r
+# -- Options for Texinfo output ----------------------------------------------\r
+\r
+# Grouping the document tree into Texinfo files. List of tuples\r
+# (source start file, target name, title, author,\r
+# dir menu entry, description, category)\r
+texinfo_documents = [\r
+ (master_doc, 'JoyVUI', u'Joy VUI Documentation',\r
+ author, 'JoyVUI', 'One line description of project.',\r
+ 'Miscellaneous'),\r
+]\r
+\r
+\r
+# -- Options for Epub output -------------------------------------------------\r
+\r
+# Bibliographic Dublin Core info.\r
+epub_title = project\r
+\r
+# The unique identifier of the text. This can be a ISBN number\r
+# or the project homepage.\r
+#\r
+# epub_identifier = ''\r
+\r
+# A unique identification for the text.\r
+#\r
+# epub_uid = ''\r
+\r
+# A list of files that should not be packed into the epub file.\r
+epub_exclude_files = ['search.html']\r
+\r
+\r
+# -- Extension configuration -------------------------------------------------\r