]>
gitweb.michael.orlitzky.com - dunshire.git/blob - doc/source/conf.py
62ac53045f9af61001520f56e891484f83bbda3d
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('../../src/'))
11 sys
.path
.insert(0, os
.path
.abspath('../../src/dunshire'))
13 # Add any Sphinx extension module names here, as strings. They can be
14 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
18 'sphinx.ext.autosummary',
19 'sphinx.ext.coverage',
21 'sphinx.ext.viewcode',
24 autosummary_generate
= True
26 # The suffix(es) of source filenames.
27 # You can specify multiple suffix as a list of string:
28 # source_suffix = ['.rst', '.md']
29 source_suffix
= '.rst'
31 # The master toctree document.
34 # General information about the project.
36 copyright
= '2016, Michael Orlitzky'
37 author
= 'Michael Orlitzky'
39 # The short X.Y version.
42 # The full version, including alpha/beta/rc tags.
45 # The language for content autogenerated by Sphinx. Refer to documentation
46 # for a list of supported languages.
48 # This is also used if you do content translation via gettext catalogs.
49 # Usually you set "language" from the command line for these cases.
52 # List of patterns, relative to source directory, that match files and
53 # directories to ignore when looking for source files.
56 # The name of the Pygments (syntax highlighting) style to use.
57 pygments_style
= 'sphinx'
59 # If true, keep warnings as "system message" paragraphs in the built documents.
60 #keep_warnings = False
62 # If true, `todo` and `todoList` produce output, else they produce nothing.
63 todo_include_todos
= False
66 # -- Options for HTML output ----------------------------------------------
68 # The theme to use for HTML and HTML Help pages. See the documentation for
69 # a list of builtin themes.
70 html_theme
= 'alabaster'
72 # Remove the search box from the default list of sidebars.
80 # http://alabaster.readthedocs.io/en/latest/customization.html#theme-options
81 html_theme_options
= {
82 'github_button': False,
85 'show_powered_by': False
88 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
89 # using the given strftime format.
90 html_last_updated_fmt
= ''
92 # If false, no index is generated.
93 #html_use_index = True
95 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
96 html_show_sphinx
= False
98 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
99 html_show_copyright
= False
101 # This is the file name suffix for HTML files (e.g. ".xhtml").
102 #html_file_suffix = None
104 # The name of a javascript file (relative to the configuration directory) that
105 # implements a search results scorer. If empty, the default will be used.
106 #html_search_scorer = 'scorer.js'
108 # Output file base name for HTML help builder.
109 htmlhelp_basename
= 'dunshiredoc'
111 # -- Options for LaTeX output ---------------------------------------------
116 # Grouping the document tree into LaTeX files. List of tuples
117 # (source start file, target name, title,
118 # author, documentclass [howto, manual, or own class]).
120 (master_doc
, 'dunshire.tex', 'Dunshire Documentation',
124 # -- Options for manual page output ---------------------------------------
126 # One entry per manual page. List of tuples
127 # (source start file, name, description, authors, manual section).
129 (master_doc
, 'Dunshire', 'Dunshire Documentation',
133 # If true, show URL addresses after external links.
134 #man_show_urls = False
137 # -- Options for Texinfo output -------------------------------------------
139 # Grouping the document tree into Texinfo files. List of tuples
140 # (source start file, target name, title, author,
141 # dir menu entry, description, category)
142 texinfo_documents
= [
143 (master_doc
, 'Dunshire', 'Dunshire Documentation',
144 author
, 'derp', 'One line description of project.',