# -*- coding: utf-8 -*-
#
# OpenViBE documentation build configuration file, created by
# sphinx-quickstart on Fri Jun 24 16:43:33 2016.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))

# -- General configuration ------------------------------------------------

extensions = [
    'sphinx.ext.todo',
    'sphinx.ext.mathjax',
    'sphinx.ext.ifconfig',
]

templates_path = ['_templates']

source_suffix = '.rst'

source_encoding = 'utf-8-sig'

master_doc = 'index'

# General information about the project.
project = u'OpenViBE'
copyright = u'2018, Inria & Mensia'
author = u'OpenViBE Team'

# The short X.Y version.
version = u'3.2'
# The full version, including alpha/beta/rc tags.
release = u'3.2'

language = None

exclude_patterns = []

pygments_style = 'sphinx'

todo_include_todos = True

html_theme = 'sphinx_rtd_theme'

html_static_path = ['_static']

html_style = 'css/openvibe.css'

html_extra_path = []

htmlhelp_basename = 'OpenViBEdoc'

rst_epilog = """
.. |Brand| replace:: OpenViBE
.. |AuthTool| replace:: Designer
.. |BulletEngCtrlPanel| replace:: Custom Tools
"""