doc/source/conf.py

   1 #!/usr/bin/env python3
   2
   3 import sys
   4 import os
   5 import shlex
   6
   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'))
  12
  13 # Add any Sphinx extension module names here, as strings. They can be
  14 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  15 # ones.
  16 extensions = [
  17     'sphinx.ext.autodoc',
  18     'sphinx.ext.autosummary',
  19     'sphinx.ext.doctest',
  20     'sphinx.ext.napoleon',
  21     'sphinx.ext.pngmath',
  22     'sphinx.ext.viewcode',
  23 ]
  24
  25 autosummary_generate = True
  26
  27 # Don't automatically test every >>> block in the documentation. This
  28 # avoids testing the API docs as part of the documentation build,
  29 # which is exactly what we intend, because those are tested as part of
  30 # the (much faster) unittest test suite.
  31 doctest_test_doctest_blocks = ''
  32
  33 # The suffix(es) of source filenames.
  34 # You can specify multiple suffix as a list of string:
  35 # source_suffix = ['.rst', '.md']
  36 source_suffix = '.rst'
  37
  38 # The master toctree document.
  39 master_doc = 'index'
  40
  41 # General information about the project.
  42 project = 'Dunshire'
  43 copyright = '2016, Michael Orlitzky'
  44 author = 'Michael Orlitzky'
  45
  46 # The short X.Y version.
  47 version = '0.0.1'
  48
  49 # The full version, including alpha/beta/rc tags.
  50 release = '0.0.1'
  51
  52 # The language for content autogenerated by Sphinx. Refer to documentation
  53 # for a list of supported languages.
  54 #
  55 # This is also used if you do content translation via gettext catalogs.
  56 # Usually you set "language" from the command line for these cases.
  57 language = None
  58
  59 # List of patterns, relative to source directory, that match files and
  60 # directories to ignore when looking for source files.
  61 exclude_patterns = []
  62
  63 # The name of the Pygments (syntax highlighting) style to use.
  64 pygments_style = 'sphinx'
  65
  66 # If true, keep warnings as "system message" paragraphs in the built documents.
  67 #keep_warnings = False
  68
  69 # If true, `todo` and `todoList` produce output, else they produce nothing.
  70 todo_include_todos = False
  71
  72
  73 # -- Options for HTML output ----------------------------------------------
  74
  75 # The theme to use for HTML and HTML Help pages.  See the documentation for
  76 # a list of builtin themes.
  77 html_theme = 'alabaster'
  78
  79 # Remove the search box from the default list of sidebars.
  80 html_sidebars = {
  81   '**': [
  82     'about.html',
  83     'navigation.html'
  84   ]
  85 }
  86
  87 # http://alabaster.readthedocs.io/en/latest/customization.html#theme-options
  88 html_theme_options = {
  89   'github_button': False,
  90   'github_user': False,
  91   'github_repo': False,
  92   'show_powered_by': False
  93 }
  94
  95 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
  96 # using the given strftime format.
  97 html_last_updated_fmt = ''
  98
  99 # If false, no index is generated.
 100 #html_use_index = True
 101
 102 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
 103 html_show_sphinx = False
 104
 105 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
 106 html_show_copyright = False
 107
 108 # This is the file name suffix for HTML files (e.g. ".xhtml").
 109 #html_file_suffix = None
 110
 111 # The name of a javascript file (relative to the configuration directory) that
 112 # implements a search results scorer. If empty, the default will be used.
 113 #html_search_scorer = 'scorer.js'
 114
 115 # Output file base name for HTML help builder.
 116 htmlhelp_basename = 'dunshiredoc'
 117
 118 # -- Options for LaTeX output ---------------------------------------------
 119
 120 latex_elements = {
 121 }
 122
 123 # Grouping the document tree into LaTeX files. List of tuples
 124 # (source start file, target name, title,
 125 #  author, documentclass [howto, manual, or own class]).
 126 latex_documents = [
 127   (master_doc, 'dunshire.tex', 'Dunshire Documentation',
 128    'author', 'manual'),
 129 ]
 130
 131 # -- Options for manual page output ---------------------------------------
 132
 133 # One entry per manual page. List of tuples
 134 # (source start file, name, description, authors, manual section).
 135 man_pages = [
 136     (master_doc, 'Dunshire', 'Dunshire Documentation',
 137      [author], 1)
 138 ]
 139
 140 # If true, show URL addresses after external links.
 141 #man_show_urls = False
 142
 143
 144 # -- Options for Texinfo output -------------------------------------------
 145
 146 # Grouping the document tree into Texinfo files. List of tuples
 147 # (source start file, target name, title, author,
 148 #  dir menu entry, description, category)
 149 texinfo_documents = [
 150   (master_doc, 'Dunshire', 'Dunshire Documentation',
 151    author, 'derp', 'One line description of project.',
 152    'Miscellaneous'),
 153 ]