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 # Don't show "dunshire.games" before every damned method.
60 add_module_names
= False
62 # The name of the Pygments (syntax highlighting) style to use.
63 pygments_style
= 'sphinx'
65 # If true, keep warnings as "system message" paragraphs in the built documents.
66 #keep_warnings = False
68 # If true, `todo` and `todoList` produce output, else they produce nothing.
69 todo_include_todos
= False
72 # -- Options for HTML output ----------------------------------------------
74 # The theme to use for HTML and HTML Help pages. See the documentation for
75 # a list of builtin themes.
76 html_theme
= 'alabaster'
78 # Remove the search box from the default list of sidebars.
86 # https://alabaster.readthedocs.io/en/latest/customization.html#theme-options
87 html_theme_options
= {
88 'github_button': False,
91 'show_powered_by': False
94 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
95 # using the given strftime format.
96 html_last_updated_fmt
= ''
98 # If false, no index is generated.
99 #html_use_index = True
101 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
102 html_show_sphinx
= False
104 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
105 html_show_copyright
= False
107 # This is the file name suffix for HTML files (e.g. ".xhtml").
108 # Warning: regardless of the suffix, sphinx will generate html5.
109 #html_file_suffix = ".xhtml"
111 # Don't include the restructured text source files for the XHTML
112 # pages, and don't display a link to them either.
113 html_show_sourcelink
= False
115 # The name of a javascript file (relative to the configuration directory) that
116 # implements a search results scorer. If empty, the default will be used.
117 #html_search_scorer = 'scorer.js'
119 # Output file base name for HTML help builder.
120 htmlhelp_basename
= 'dunshiredoc'
122 # -- Options for LaTeX output ---------------------------------------------
125 'preamble' : r
'\usepackage{amsfonts,amssymb}',
129 # Grouping the document tree into LaTeX files. List of tuples
130 # (source start file, target name, title,
131 # author, documentclass [howto, manual, or own class]).
133 (master_doc
, 'dunshire.tex', project
+ ' Documentation',
137 # -- Options for manual page output ---------------------------------------
139 # One entry per manual page. List of tuples
140 # (source start file, name, description, authors, manual section).
142 (master_doc
, project
, project
+ ' Documentation',
146 # If true, show URL addresses after external links.
147 #man_show_urls = False
150 # -- Options for Texinfo output -------------------------------------------
152 # Grouping the document tree into Texinfo files. List of tuples
153 # (source start file, target name, title, author,
154 # dir menu entry, description, category)
155 texinfo_documents
= [
156 (master_doc
, project
, project
+ ' Documentation',
157 author
, 'derp', 'One line description of project.',