usrbinenv python coding utf8 facerecognition documentation build configuration file sphinxquickstart on tue jul 9 22 26 36 2013 this file is execfiled 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 sys path insert0 os path abspath get the project root dir which is the parent dir of this insert the project root dir as the first element in the pythonpath this lets us ensure that the source package is imported and that its version is used general configuration if your documentation needs a minimal sphinx version state it here needssphinx 1 0 add any sphinx extension module names here as strings they can be extensions coming with sphinx named sphinx ext or your custom ones add any paths that contain templates here relative to this directory the suffix of source filenames the encoding of source files sourceencoding utf8sig the master toctree document general information about the project the version info for the project you re documenting acts as replacement for version and release also used in various other places throughout the built documents the short x y version the full version including alphabetarc tags the language for content autogenerated by sphinx refer to documentation for a list of supported languages language none there are two options for replacing today either you set today to some nonfalse value then it is used today else todayfmt is used as the format for a strftime call todayfmt b d y list of patterns relative to source directory that match files and directories to ignore when looking for source files the rest default role used for this markup text to use for all documents defaultrole none if true will be appended to func etc crossreference text addfunctionparentheses true if true the current module name will be prepended to all description unit titles such as function addmodulenames true if true section and module directives will be shown in the output they are ignored by default shows false the name of the pygments syntax highlighting style to use a list of ignored prefixes for module index sorting modindexcommonprefix if true keep warnings as system message paragraphs in the built documents keepwarnings false options for html output the theme to use for html and html help pages see the documentation for a list of builtin themes theme options are themespecific and customize the look and feel of a theme further for a list of options available for each theme see the documentation htmlthemeoptions add any paths that contain custom themes here relative to this directory htmlthemepath the name for this set of sphinx documents if none it defaults to project vrelease documentation htmltitle none a shorter title for the navigation bar default is the same as htmltitle htmlshorttitle none the name of an image file relative to this directory to place at the top of the sidebar htmllogo none the name of an image file within the static path to use as favicon of the docs this file should be a windows icon file ico being 16x16 or 32x32 pixels large htmlfavicon none add any paths that contain custom static files such as style sheets here relative to this directory they are copied after the builtin static files so a file named default css will overwrite the builtin default css if not a last updated on timestamp is inserted at every page bottom using the given strftime format htmllastupdatedfmt b d y if true smartypants will be used to convert quotes and dashes to typographically correct entities htmlusesmartypants true custom sidebar templates maps document names to template names htmlsidebars additional templates that should be rendered to pages maps page names to template names htmladditionalpages if false no module index is generated htmldomainindices true if false no index is generated htmluseindex true if true the index is split into individual pages for each letter htmlsplitindex false if true links to the rest sources are added to the pages htmlshowsourcelink true if true created using sphinx is shown in the html footer default is true htmlshowsphinx true if true c is shown in the html footer default is true htmlshow true if true an opensearch description file will be output and all pages will contain a link tag referring to it the value of this option must be the base url from which the finished html is served htmluseopensearch this is the file name suffix for html files e g xhtml htmlfilesuffix none output file base name for html help builder options for latex output the paper size letterpaper or a4paper papersize letterpaper the font size 10pt 11pt or 12pt pointsize 10pt additional stuff for the latex preamble preamble grouping the document tree into latex files list of tuples source start file target name title documentclass howtomanual the name of an image file relative to this directory to place at the top of the title page latexlogo none for manual documents if this is true then toplevel headings are parts not chapters latexuseparts false if true show page references after internal links latexshowpagerefs false if true show url addresses after external links latexshowurls false documents to append as an appendix to all manuals latexappendices if false no module index is generated latexdomainindices true options for manual page output one entry per manual page list of tuples source start file name description s manual section if true show url addresses after external links manshowurls false options for texinfo output grouping the document tree into texinfo files list of tuples source start file target name title dir menu entry description category documents to append as an appendix to all manuals texinfoappendices if false no module index is generated texinfodomainindices true how to display url addresses footnote no or inline texinfoshowurls footnote if true do not generate a detailmenu in the top node s menu texinfonodetailmenu false usr bin env python coding utf 8 face_recognition documentation build configuration file sphinx quickstart on tue jul 9 22 26 36 2013 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 sys path insert 0 os path abspath get the project root dir which is the parent dir of this insert the project root dir as the first element in the pythonpath this lets us ensure that the source package is imported and that its version is used general configuration if your documentation needs a minimal sphinx version state it here needs_sphinx 1 0 add any sphinx extension module names here as strings they can be extensions coming with sphinx named sphinx ext or your custom ones add any paths that contain templates here relative to this directory the suffix of source filenames the encoding of source files source_encoding utf 8 sig the master toctree document general information about the project the version info for the project you re documenting acts as replacement for version and release also used in various other places throughout the built documents the short x y version the full version including alpha beta rc tags the language for content autogenerated by sphinx refer to documentation for a list of supported languages language none there are two options for replacing today either you set today to some non false value then it is used today else today_fmt is used as the format for a strftime call today_fmt b d y list of patterns relative to source directory that match files and directories to ignore when looking for source files the rest default role used for this markup text to use for all documents default_role none if true will be appended to func etc cross reference text add_function_parentheses true if true the current module name will be prepended to all description unit titles such as function add_module_names true if true section and module directives will be shown in the output they are ignored by default show_s false the name of the pygments syntax highlighting style to use a list of ignored prefixes for module index sorting modindex_common_prefix if true keep warnings as system message paragraphs in the built documents keep_warnings false options for html output the theme to use for html and html help pages see the documentation for a list of builtin themes theme options are theme specific and customize the look and feel of a theme further for a list of options available for each theme see the documentation html_theme_options add any paths that contain custom themes here relative to this directory html_theme_path the name for this set of sphinx documents if none it defaults to project v release documentation html_title none a shorter title for the navigation bar default is the same as html_title html_short_title none the name of an image file relative to this directory to place at the top of the sidebar html_logo none the name of an image file within the static path to use as favicon of the docs this file should be a windows icon file ico being 16x16 or 32x32 pixels large html_favicon none add any paths that contain custom static files such as style sheets here relative to this directory they are copied after the builtin static files so a file named default css will overwrite the builtin default css if not a last updated on timestamp is inserted at every page bottom using the given strftime format html_last_updated_fmt b d y if true smartypants will be used to convert quotes and dashes to typographically correct entities html_use_smartypants true custom sidebar templates maps document names to template names html_sidebars additional templates that should be rendered to pages maps page names to template names html_additional_pages if false no module index is generated html_domain_indices true if false no index is generated html_use_index true if true the index is split into individual pages for each letter html_split_index false if true links to the rest sources are added to the pages html_show_sourcelink true if true created using sphinx is shown in the html footer default is true html_show_sphinx true if true c is shown in the html footer default is true html_show_ true if true an opensearch description file will be output and all pages will contain a link tag referring to it the value of this option must be the base url from which the finished html is served html_use_opensearch this is the file name suffix for html files e g xhtml html_file_suffix none output file base name for html help builder options for latex output the paper size letterpaper or a4paper papersize letterpaper the font size 10pt 11pt or 12pt pointsize 10pt additional stuff for the latex preamble preamble grouping the document tree into latex files list of tuples source start file target name title documentclass howto manual the name of an image file relative to this directory to place at the top of the title page latex_logo none for manual documents if this is true then toplevel headings are parts not chapters latex_use_parts false if true show page references after internal links latex_show_pagerefs false if true show url addresses after external links latex_show_urls false documents to append as an appendix to all manuals latex_appendices if false no module index is generated latex_domain_indices true options for manual page output one entry per manual page list of tuples source start file name description s manual section if true show url addresses after external links man_show_urls false options for texinfo output grouping the document tree into texinfo files list of tuples source start file target name title dir menu entry description category documents to append as an appendix to all manuals texinfo_appendices if false no module index is generated texinfo_domain_indices true how to display url addresses footnote no or inline texinfo_show_urls footnote if true do not generate a detailmenu in the top node s menu texinfo_no_detailmenu false
import sys
import os
from unittest.mock import MagicMock

class Mock(MagicMock):
    @classmethod
    def __getattr__(cls, name):
            return MagicMock()

MOCK_MODULES = ['face_recognition_models', 'Click', 'dlib', 'numpy', 'PIL']
sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)








cwd = os.getcwd()
project_root = os.path.dirname(cwd)




sys.path.insert(0, project_root)

import face_recognition








extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']


templates_path = ['_templates']


source_suffix = '.rst'





master_doc = 'index'


project = u'Face Recognition'
copyright = u"2017, Adam Geitgey"






version = face_recognition.__version__

release = face_recognition.__version__













exclude_patterns = ['_build']

















pygments_style = 'sphinx'













html_theme = 'default'






























html_static_path = ['_static']













































htmlhelp_basename = 'face_recognitiondoc'




latex_elements = {
    
    

    
    

    
    
}




latex_documents = [
    ('index', 'face_recognition.tex',
     u'Face Recognition Documentation',
     u'Adam Geitgey', 'manual'),
]


























man_pages = [
    ('index', 'face_recognition',
     u'Face Recognition Documentation',
     [u'Adam Geitgey'], 1)
]










texinfo_documents = [
    ('index', 'face_recognition',
     u'Face Recognition Documentation',
     u'Adam Geitgey',
     'face_recognition',
     'One line description of project.',
     'Miscellaneous'),
]