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('../../'))
  11
  12 # Add any Sphinx extension module names here, as strings. They can be
  13 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  14 # ones.
  15 extensions = [
  16     'sphinx.ext.autodoc',
  17     'sphinx.ext.doctest',
  18     'sphinx.ext.mathjax',
  19     'sphinx.ext.napoleon',
  20     'sphinx.ext.viewcode',
  21 ]
  22
  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 = ''
  28
  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'
  33
  34 # The master toctree document.
  35 master_doc = 'index'
  36
  37 # General information about the project.
  38 project = 'Dunshire'
  39 copyright = '2016, Michael Orlitzky'
  40 author = 'Michael Orlitzky'
  41
  42 # The short X.Y version.
  43 version = '0.1.1'
  44
  45 # The full version, including alpha/beta/rc tags.
  46 release = '0.1.1'
  47
  48 # The language for content autogenerated by Sphinx. Refer to documentation
  49 # for a list of supported languages.
  50 #
  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.
  53 language = "en"
  54
  55 # List of patterns, relative to source directory, that match files and
  56 # directories to ignore when looking for source files.
  57 exclude_patterns = []
  58
  59 # Don't show "dunshire.games" before every damned method.
  60 add_module_names = False
  61
  62 # The name of the Pygments (syntax highlighting) style to use.
  63 pygments_style = 'sphinx'
  64
  65 # If true, keep warnings as "system message" paragraphs in the built documents.
  66 #keep_warnings = False
  67
  68 # If true, `todo` and `todoList` produce output, else they produce nothing.
  69 todo_include_todos = False
  70
  71
  72 # -- Options for HTML output ----------------------------------------------
  73
  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'
  77
  78 # Remove the search box from the default list of sidebars.
  79 html_sidebars = {
  80   '**': [
  81     'about.html',
  82     'navigation.html'
  83   ]
  84 }
  85
  86 # https://alabaster.readthedocs.io/en/latest/customization.html#theme-options
  87 html_theme_options = {
  88   'github_button': False,
  89   'github_user': False,
  90   'github_repo': False,
  91   'page_width': 'auto',
  92   'show_powered_by': False,
  93   'sidebar_width': '30em'
  94 }
  95
  96 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
  97 # using the given strftime format.
  98 html_last_updated_fmt = ''
  99
 100 # If false, no index is generated.
 101 #html_use_index = True
 102
 103 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
 104 html_show_sphinx = False
 105
 106 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
 107 html_show_copyright = False
 108
 109 # This is the file name suffix for HTML files (e.g. ".xhtml").
 110 # Warning: regardless of the suffix, sphinx will generate html5.
 111 #html_file_suffix = ".xhtml"
 112
 113 # Don't include the restructured text source files for the XHTML
 114 # pages, and don't display a link to them either.
 115 html_show_sourcelink = False
 116
 117 # The name of a javascript file (relative to the configuration directory) that
 118 # implements a search results scorer. If empty, the default will be used.
 119 #html_search_scorer = 'scorer.js'
 120
 121 # Output file base name for HTML help builder.
 122 htmlhelp_basename = 'dunshiredoc'
 123
 124 # -- Options for LaTeX output ---------------------------------------------
 125
 126 latex_elements = {
 127     'preamble' : r'\usepackage{amsfonts,amssymb}',
 128     'printindex' : ''
 129 }
 130
 131 # Grouping the document tree into LaTeX files. List of tuples
 132 # (source start file, target name, title,
 133 #  author, documentclass [howto, manual, or own class]).
 134 latex_documents = [
 135   (master_doc, 'dunshire.tex', project + ' Documentation',
 136    author, 'manual'),
 137 ]
 138
 139 # -- Options for manual page output ---------------------------------------
 140
 141 # One entry per manual page. List of tuples
 142 # (source start file, name, description, authors, manual section).
 143 man_pages = [
 144     (master_doc, project, project + ' Documentation',
 145      [author], 1)
 146 ]
 147
 148 # If true, show URL addresses after external links.
 149 #man_show_urls = False
 150
 151
 152 # -- Options for Texinfo output -------------------------------------------
 153
 154 # Grouping the document tree into Texinfo files. List of tuples
 155 # (source start file, target name, title, author,
 156 #  dir menu entry, description, category)
 157 texinfo_documents = [
 158   (master_doc, project, project + ' Documentation',
 159    author, 'derp', 'One line description of project.',
 160    'Miscellaneous'),
 161 ]