openface/api-docs/conf.py

74 lines
1.4 KiB
Python

#!/usr/bin/env python2
import sys
import mock
import os
sys.path.insert(0, os.path.abspath('..'))
MOCK_MODULES = ['argparse', 'cv2', 'dlib', 'numpy', 'pandas']
for mod_name in MOCK_MODULES:
sys.modules[mod_name] = mock.MagicMock()
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.coverage',
'sphinx.ext.mathjax',
'sphinx.ext.viewcode',
]
autoclass_content = 'both'
templates_path = ['_templates']
source_suffix = '.rst'
# The master toctree document.
master_doc = 'index'
project = 'OpenFace API Docs'
copyright = '2015-2016, Carnegie Mellon University'
author = 'Carnegie Mellon University'
version = '0.1.1'
release = '0.1.1'
language = None
exclude_patterns = ['_build']
pygments_style = 'sphinx'
todo_include_todos = True
def setup(app):
app.add_javascript("sp.js")
app.add_javascript("track.js")
# html_theme = 'alabaster'
html_theme = 'sphinx_rtd_theme'
html_static_path = ['_static']
htmlhelp_basename = 'OpenFacedoc'
latex_elements = {
'papersize': 'letterpaper',
'pointsize': '12pt',
}
latex_documents = [
(master_doc, 'OpenFace.tex', 'OpenFace Documentation',
'Carnegie Mellon University', 'manual'),
]
man_pages = [
(master_doc, 'openface', 'OpenFace Documentation',
[author], 1)
]
texinfo_documents = [
(master_doc, 'OpenFace', 'OpenFace Documentation',
author, 'OpenFace', 'One line description of project.',
'Miscellaneous'),
]