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