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