1 #!/usr/bin/env python3  2 # -*- coding: utf-8 -*-  3 #  4 # PoreSpy documentation build configuration file, created by  5 # sphinx-quickstart on Fri Jul 28 00:04:40 2017.  6 #  7 # This file is execfile()d with the current directory set to its  8 # containing dir.  9 #  10 # Note that not all possible configuration values are present in this  11 # autogenerated file.  12 #  13 # All configuration values have a default; values that are commented out  14 # serve to show the default.  15 16 # If extensions (or modules to document with autodoc) are in another directory,  17 # add these directories to sys.path here. If the directory is relative to the  18 # documentation root, use os.path.abspath to make it absolute, like shown here.  19 20 1 import os  21 1 import sys  22 1 import datetime  23 24 1 sys.path.insert(0, os.path.abspath('.'))  25 1 sys.path.insert(0, os.path.abspath('../'))  26 1 sys.path.insert(0, os.path.abspath('../../'))  27 28 # -- General configuration ------------------------------------------------  29 30 # If your documentation needs a minimal Sphinx version, state it here.  31 #  32 # needs_sphinx = '1.0'  33 34 # Add any Sphinx extension module names here, as strings. They can be  35 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom  36 # ones.  37 38 1 extensions = ['sphinx.ext.autodoc',  39  'sphinx.ext.napoleon',  40  'sphinx.ext.autosummary',  41  'sphinx.ext.ifconfig',  42  'sphinx.ext.viewcode',  43  'sphinx.ext.mathjax',  44  ]  45 46 1 exclude_patterns = ['_build', '_templates']  47 48 # Add any paths that contain templates here, relative to this directory.  49 1 templates_path = ['_templates']  50 51 # The suffix(es) of source filenames.  52 # You can specify multiple suffix as a list of string:  53 54 # The master toctree document.  55 1 master_doc = 'index'  56 57 # General information about the project.  58 59 1 project = 'PoreSpy'  60 1 year = datetime.datetime.now().year  61 1 copyright = '%d PoreSpy Team' % year  62 1 author = 'PMEAL Team'  63 64 # The version info for the project you're documenting, acts as replacement for  65 # |version| and |release|, also used in various other places throughout the  66 # built documents.  67 #  68 # The short X.Y version.  69 # version = '0.2'  70 # The full version, including alpha/beta/rc tags.  71 # release = '0.2'  72 73 # The language for content autogenerated by Sphinx. Refer to documentation  74 # for a list of supported languages.  75 #  76 # This is also used if you do content translation via gettext catalogs.  77 # Usually you set "language" from the command line for these cases.  78 1 language = None  79 80 # List of patterns, relative to source directory, that match files and  81 # directories to ignore when looking for source files.  82 # This patterns also effect to html_static_path and html_extra_path  83 1 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']  84 85 # The name of the Pygments (syntax highlighting) style to use.  86 1 pygments_style = 'sphinx'  87 88 # If true, todo and todoList produce output, else they produce nothing.  89 1 todo_include_todos = False  90 91 # A list of ignored prefixes for module index sorting.  92 1 modindex_common_prefix = ['porespy']  93 94 # If false, no module index is generated.  95 1 html_domain_indices = True  96 97 # If false, no index is generated.  98 1 html_use_index = True  99 100 # If true, the index is split into individual pages for each letter.  101 1 html_split_index = False  102 103 # If true, links to the reST sources are added to the pages.  104 1 html_show_sourcelink = False  105 106 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.  107 1 html_show_sphinx = False  108 109 # -- Options for HTML output ----------------------------------------------  110 111 # The theme to use for HTML and HTML Help pages. See the documentation for  112 # a list of builtin themes.  113 #  114 1 html_theme = 'sphinx_rtd_theme'  115 116 # Theme options are theme-specific and customize the look and feel of a theme  117 # further. For a list of options available for each theme, see the  118 # documentation.  119 #  120 # html_theme_options = {}  121 122 # Add any paths that contain custom static files (such as style sheets) here,  123 # relative to this directory. They are copied after the builtin static files,  124 # so a file named "default.css" will overwrite the builtin "default.css".  125 1 html_static_path = ['_static']  126 127 128 # -- Options for HTMLHelp output ------------------------------------------  129 130 # Output file base name for HTML help builder.  131 1 htmlhelp_basename = 'PoreSpydoc'  132 133 134 # -- Options for LaTeX output ---------------------------------------------  135 136 1 latex_elements = {  137  # The paper size ('letterpaper' or 'a4paper').  138  #  139  # 'papersize': 'letterpaper',  140 141  # The font size ('10pt', '11pt' or '12pt').  142  #  143  # 'pointsize': '10pt',  144 145  # Additional stuff for the LaTeX preamble.  146  #  147  # 'preamble': '',  148 149  # Latex figure (float) alignment  150  #  151  # 'figure_align': 'htbp',  152 }  153 154 # Grouping the document tree into LaTeX files. List of tuples  155 # (source start file, target name, title,  156 # author, documentclass [howto, manual, or own class]).  157 1 latex_documents = [  158  (master_doc, 'PoreSpy.tex', 'PoreSpy Documentation',  159  'PMEAL Team', 'manual'),  160 ]  161 162 163 # -- Options for manual page output ---------------------------------------  164 165 # One entry per manual page. List of tuples  166 # (source start file, name, description, authors, manual section).  167 1 man_pages = [  168  (master_doc, 'porespy', 'PoreSpy Documentation',  169  [author], 1)  170 ]  171 172 173 # -- Options for Texinfo output -------------------------------------------  174 175 # Grouping the document tree into Texinfo files. List of tuples  176 # (source start file, target name, title, author,  177 # dir menu entry, description, category)  178 1 texinfo_documents = [  179  (master_doc, 'PoreSpy', 'PoreSpy Documentation',  180  author, 'PoreSpy', 'One line description of project.',  181  'Miscellaneous'),  182 ] 

Read our documentation on viewing source code .