7 # If extensions (or modules to document with autodoc) are in another directory,
8 # add these directories to sys.path here. If the directory is relative to the
9 # documentation root, use os.path.abspath to make it absolute, like shown here.
10 sys
.path
.insert(0, os
.path
.abspath('../../'))
12 # Add any Sphinx extension module names here, as strings. They can be
13 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
19 'sphinx.ext.napoleon',
20 'sphinx.ext.viewcode',
23 # Don't automatically test every >>> block in the documentation. This
24 # avoids testing the API docs as part of the documentation build,
25 # which is exactly what we intend, because those are tested as part of
26 # the (much faster) unittest test suite.
27 doctest_test_doctest_blocks
= ''
29 # The suffix(es) of source filenames.
30 # You can specify multiple suffix as a list of string:
31 # source_suffix = ['.rst', '.md']
32 source_suffix
= '.rst'
34 # The master toctree document.
37 # General information about the project.
39 copyright
= '2016, Michael Orlitzky'
40 author
= 'Michael Orlitzky'
42 # The short X.Y version.
45 # The full version, including alpha/beta/rc tags.
48 # The language for content autogenerated by Sphinx. Refer to documentation
49 # for a list of supported languages.
51 # This is also used if you do content translation via gettext catalogs.
52 # Usually you set "language" from the command line for these cases.
55 # List of patterns, relative to source directory, that match files and
56 # directories to ignore when looking for source files.
59 # The name of the Pygments (syntax highlighting) style to use.
60 pygments_style
= 'sphinx'
62 # If true, keep warnings as "system message" paragraphs in the built documents.
63 #keep_warnings = False
65 # If true, `todo` and `todoList` produce output, else they produce nothing.
66 todo_include_todos
= False
69 # -- Options for HTML output ----------------------------------------------
71 # The theme to use for HTML and HTML Help pages. See the documentation for
72 # a list of builtin themes.
73 html_theme
= 'alabaster'
75 # Remove the search box from the default list of sidebars.
83 # http://alabaster.readthedocs.io/en/latest/customization.html#theme-options
84 html_theme_options
= {
85 'github_button': False,
88 'show_powered_by': False
91 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
92 # using the given strftime format.
93 html_last_updated_fmt
= ''
95 # If false, no index is generated.
96 #html_use_index = True
98 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
99 html_show_sphinx
= False
101 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
102 html_show_copyright
= False
104 # This is the file name suffix for HTML files (e.g. ".xhtml").
105 #html_file_suffix = None
107 # The name of a javascript file (relative to the configuration directory) that
108 # implements a search results scorer. If empty, the default will be used.
109 #html_search_scorer = 'scorer.js'
111 # Output file base name for HTML help builder.
112 htmlhelp_basename
= 'dunshiredoc'
114 # -- Options for LaTeX output ---------------------------------------------
119 # Grouping the document tree into LaTeX files. List of tuples
120 # (source start file, target name, title,
121 # author, documentclass [howto, manual, or own class]).
123 (master_doc
, 'dunshire.tex', 'Dunshire Documentation',
127 # -- Options for manual page output ---------------------------------------
129 # One entry per manual page. List of tuples
130 # (source start file, name, description, authors, manual section).
132 (master_doc
, 'Dunshire', 'Dunshire Documentation',
136 # If true, show URL addresses after external links.
137 #man_show_urls = False
140 # -- Options for Texinfo output -------------------------------------------
142 # Grouping the document tree into Texinfo files. List of tuples
143 # (source start file, target name, title, author,
144 # dir menu entry, description, category)
145 texinfo_documents
= [
146 (master_doc
, 'Dunshire', 'Dunshire Documentation',
147 author
, 'derp', 'One line description of project.',