usrbinenv python3 coding utf8 algorithms documentation build configuration file sphinxquickstart on wed jun 6 01 17 26 2018 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 import os import sys sys path insert0 os path abspath 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 suffixes of source filenames you can specify multiple suffix as a list of string 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 this is also used if you do content translation via gettext catalogs usually you set language from the command line for these cases list of patterns relative to source directory that match files and directories to ignore when looking for source files this patterns also effect to htmlstaticpath and htmlextrapath the name of the pygments syntax highlighting style to use if true todo and todolist produce output else they produce nothing 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 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 custom sidebar templates must be a dictionary that maps document names to template names this is required for the alabaster theme refs http alabaster readthedocs ioenlatestinstallation htmlsidebars options for htmlhelp output 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 latex figure float alignment figurealign htbp grouping the document tree into latex files list of tuples source start file target name title documentclass howto manual or own class options for manual page output one entry per manual page list of tuples source start file name description s manual section 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 usr bin env python3 coding utf 8 algorithms documentation build configuration file sphinx quickstart on wed jun 6 01 17 26 2018 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 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 es of source filenames you can specify multiple suffix as a list of string 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 this is also used if you do content translation via gettext catalogs usually you set language from the command line for these cases list of patterns relative to source directory that match files and directories to ignore when looking for source files this patterns also effect to html_static_path and html_extra_path the name of the pygments syntax highlighting style to use if true todo and todolist produce output else they produce nothing 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 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 custom sidebar templates must be a dictionary that maps document names to template names this is required for the alabaster theme refs http alabaster readthedocs io en latest installation html sidebars needs show_related true theme option to display options for htmlhelp output 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 latex figure float alignment figure_align htbp grouping the document tree into latex files list of tuples source start file target name title documentclass howto manual or own class options for manual page output one entry per manual page list of tuples source start file name description s manual section 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
from recommonmark.parser import CommonMarkParser










extensions = ['sphinx.ext.autodoc',
              'sphinx.ext.doctest',
              'sphinx.ext.todo',
              'sphinx.ext.coverage',
              'sphinx.ext.mathjax',
              'sphinx.ext.ifconfig',
              'sphinx.ext.viewcode',
              'sphinx.ext.githubpages']


templates_path = ['_templates']




source_parsers = {
    '.md': CommonMarkParser
}
source_suffix = ['.rst', '.md']


master_doc = 'index'


project = 'algorithms'
copyright = '2018, Algorithms Team & Contributors'
author = 'Algorithms Team & Contributors'






version = '0.1.0'

release = '0.1.0'






language = None




exclude_patterns = []


pygments_style = 'sphinx'


todo_include_todos = True







html_theme = 'alabaster'










html_static_path = ['_static']






html_sidebars = {
    '**': [
        'about.html',
        'searchbox.html',
        'navigation.html',
        'relations.html',  
    ]
}





htmlhelp_basename = 'algorithmsdoc'




latex_elements = {
    
    
    

    
    
    

    
    
    

    
    
    
}




latex_documents = [
    (master_doc, 'algorithms.tex', 'algorithms Documentation',
     'Algorithms Team \\& Contributors', 'manual'),
]






man_pages = [
    (master_doc, 'algorithms', 'algorithms Documentation',
     [author], 1)
]







texinfo_documents = [
    (master_doc, 'algorithms', 'algorithms Documentation',
     author, 'algorithms', 'One line description of project.',
     'Miscellaneous'),
]