doc/conf.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # bugs-everywhere documentation build configuration file, created by
   4 # sphinx-quickstart on Fri Feb  5 20:02:21 2010.
   5 #
   6 # This file is execfile()d with the current directory set to its containing dir.
   7 #
   8 # Note that not all possible configuration values are present in this
   9 # autogenerated file.
  10 #
  11 # All configuration values have a default; values that are commented out
  12 # serve to show the default.
  13
  14 import sys, os
  15
  16 # If extensions (or modules to document with autodoc) are in another directory,
  17 # add these directories to sys.path here. If the directory is relative to the
  18 # documentation root, use os.path.abspath to make it absolute, like shown here.
  19 #sys.path.append(os.path.abspath('.'))
  20 sys.path.insert(0, os.path.abspath('..'))
  21
  22 import libbe.version
  23
  24 # -- General configuration -----------------------------------------------------
  25
  26 # Add any Sphinx extension module names here, as strings. They can be extensions
  27 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
  28 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.autosummary',
  29               'sphinx.ext.doctest', 'sphinx.ext.coverage',
  30               'numpydoc']
  31
  32 # Add any paths that contain templates here, relative to this directory.
  33 templates_path = ['.templates']
  34
  35 # The suffix of source filenames.
  36 source_suffix = '.txt'
  37
  38 # The encoding of source files.
  39 #source_encoding = 'utf-8'
  40
  41 # The master toctree document.
  42 master_doc = 'index'
  43
  44 # General information about the project.
  45 project = u'bugs-everywhere'
  46 copyright = u'2010, W. Trevor King'
  47
  48 # The version info for the project you're documenting, acts as replacement for
  49 # |version| and |release|, also used in various other places throughout the
  50 # built documents.
  51 #
  52 # The short X.Y version.
  53 version = libbe.version.version(3)
  54 # The full version, including alpha/beta/rc tags.
  55 release = '{} ({})'.format(
  56     libbe.version.version(),
  57     libbe.version.version_info['date'])
  58
  59 # The language for content autogenerated by Sphinx. Refer to documentation
  60 # for a list of supported languages.
  61 #language = None
  62
  63 # There are two options for replacing |today|: either, you set today to some
  64 # non-false value, then it is used:
  65 #today = ''
  66 # Else, today_fmt is used as the format for a strftime call.
  67 #today_fmt = '%B %d, %Y'
  68
  69 # List of documents that shouldn't be included in the build.
  70 #unused_docs = []
  71
  72 # List of directories, relative to source directory, that shouldn't be searched
  73 # for source files.
  74 exclude_trees = ['.build']
  75
  76 # The reST default role (used for this markup: `text`) to use for all documents.
  77 #default_role = None
  78
  79 # If true, '()' will be appended to :py:func: etc. cross-reference text.
  80 #add_function_parentheses = True
  81
  82 # If true, the current module name will be prepended to all description
  83 # unit titles (such as .. function::).
  84 #add_module_names = True
  85
  86 # If true, sectionauthor and moduleauthor directives will be shown in the
  87 # output. They are ignored by default.
  88 #show_authors = False
  89
  90 # The name of the Pygments (syntax highlighting) style to use.
  91 pygments_style = 'sphinx'
  92
  93 # A list of ignored prefixes for module index sorting.
  94 #modindex_common_prefix = []
  95
  96
  97 # -- Options for HTML output ---------------------------------------------------
  98
  99 # The theme to use for HTML and HTML Help pages.  Major themes that come with
 100 # Sphinx are currently 'default' and 'sphinxdoc'.
 101 html_theme = 'default'
 102
 103 # Theme options are theme-specific and customize the look and feel of a theme
 104 # further.  For a list of options available for each theme, see the
 105 # documentation.
 106 #html_theme_options = {}
 107
 108 # Add any paths that contain custom themes here, relative to this directory.
 109 #html_theme_path = []
 110
 111 # The name for this set of Sphinx documents.  If None, it defaults to
 112 # "<project> v<release> documentation".
 113 #html_title = None
 114
 115 # Override default sphinx.config.Config.configvalues[html_title] to
 116 # change formatting string from '%s v%s' to '%s %s'.  With git-commit
 117 # versions, the original formatting string gives titles like
 118 #   bugs-everywhere vc07c687273afc1f38258d3fa5caf39244c0d1b33
 119 # which may suprise users who don't realize the leading 'v' is not
 120 # part of the hash.
 121 html_title = '%s %s documentation' % (project, version)
 122
 123 # A shorter title for the navigation bar.  Default is the same as html_title.
 124 #html_short_title = None
 125 html_short_title = '%s %s documentation' % (project, release)
 126
 127 # The name of an image file (relative to this directory) to place at the top
 128 # of the sidebar.
 129 #html_logo = None
 130
 131 # The name of an image file (within the static path) to use as favicon of the
 132 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 133 # pixels large.
 134 #html_favicon = None
 135
 136 # Add any paths that contain custom static files (such as style sheets) here,
 137 # relative to this directory. They are copied after the builtin static files,
 138 # so a file named "default.css" will overwrite the builtin "default.css".
 139 html_static_path = ['.static']
 140
 141 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 142 # using the given strftime format.
 143 #html_last_updated_fmt = '%b %d, %Y'
 144
 145 # If true, SmartyPants will be used to convert quotes and dashes to
 146 # typographically correct entities.
 147 #html_use_smartypants = True
 148
 149 # Custom sidebar templates, maps document names to template names.
 150 #html_sidebars = {}
 151
 152 # Additional templates that should be rendered to pages, maps page names to
 153 # template names.
 154 #html_additional_pages = {}
 155
 156 # If false, no module index is generated.
 157 #html_use_modindex = True
 158
 159 # If false, no index is generated.
 160 #html_use_index = True
 161
 162 # If true, the index is split into individual pages for each letter.
 163 #html_split_index = False
 164
 165 # If true, links to the reST sources are added to the pages.
 166 #html_show_sourcelink = True
 167
 168 # If true, an OpenSearch description file will be output, and all pages will
 169 # contain a <link> tag referring to it.  The value of this option must be the
 170 # base URL from which the finished HTML is served.
 171 #html_use_opensearch = ''
 172
 173 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
 174 #html_file_suffix = ''
 175
 176 # Output file base name for HTML help builder.
 177 htmlhelp_basename = 'bugs-everywheredoc'
 178
 179
 180 # -- Options for LaTeX output --------------------------------------------------
 181
 182 # The paper size ('letter' or 'a4').
 183 #latex_paper_size = 'letter'
 184
 185 # The font size ('10pt', '11pt' or '12pt').
 186 #latex_font_size = '10pt'
 187
 188 # Grouping the document tree into LaTeX files. List of tuples
 189 # (source start file, target name, title, author, documentclass [howto/manual]).
 190 latex_documents = [
 191   ('index', 'bugs-everywhere.tex', u'bugs-everywhere Documentation',
 192    u'W. Trevor King', 'manual'),
 193 ]
 194
 195 # The name of an image file (relative to this directory) to place at the top of
 196 # the title page.
 197 #latex_logo = None
 198
 199 # For "manual" documents, if this is true, then toplevel headings are parts,
 200 # not chapters.
 201 #latex_use_parts = False
 202
 203 # Additional stuff for the LaTeX preamble.
 204 #latex_preamble = ''
 205
 206 # Documents to append as an appendix to all manuals.
 207 #latex_appendices = []
 208
 209 # If false, no module index is generated.
 210 #latex_use_modindex = True
 211
 212 # -- Options for Intersphinx ---------------------------------------------------
 213
 214 intersphinx_mapping = {
 215     'http://docs.python.org/dev': None,
 216     }