Mercurial > public > m209

annotate docs/conf.py @ 52:5b335e8af407

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Started roughing in some docs using Sphinx.
author Brian Neal <bgneal@gmail.com>
date Thu, 04 Jul 2013 22:41:30 -0500
parents 9c994664fdd6
children
rev   line source
bgneal@51 1 #!/usr/bin/env python3
bgneal@51 2 # -*- coding: utf-8 -*-
bgneal@51 3 #
bgneal@51 4 # m209 documentation build configuration file, created by
bgneal@51 5 # sphinx-quickstart on Thu Jul 4 18:12:07 2013.
bgneal@51 6 #
bgneal@51 7 # This file is execfile()d with the current directory set to its containing dir.
bgneal@51 8 #
bgneal@51 9 # Note that not all possible configuration values are present in this
bgneal@51 10 # autogenerated file.
bgneal@51 11 #
bgneal@51 12 # All configuration values have a default; values that are commented out
bgneal@51 13 # serve to show the default.
bgneal@51 14
bgneal@51 15 import sys, os
bgneal@51 16
bgneal@51 17 # If extensions (or modules to document with autodoc) are in another directory,
bgneal@51 18 # add these directories to sys.path here. If the directory is relative to the
bgneal@51 19 # documentation root, use os.path.abspath to make it absolute, like shown here.
bgneal@51 20 #sys.path.insert(0, os.path.abspath('.'))
bgneal@51 21
bgneal@51 22 # -- General configuration -----------------------------------------------------
bgneal@51 23
bgneal@51 24 # If your documentation needs a minimal Sphinx version, state it here.
bgneal@51 25 #needs_sphinx = '1.0'
bgneal@51 26
bgneal@51 27 # Add any Sphinx extension module names here, as strings. They can be extensions
bgneal@51 28 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
bgneal@51 29 extensions = ['sphinx.ext.autodoc']
bgneal@51 30
bgneal@51 31 # Add any paths that contain templates here, relative to this directory.
bgneal@51 32 templates_path = ['_templates']
bgneal@51 33
bgneal@51 34 # The suffix of source filenames.
bgneal@51 35 source_suffix = '.rst'
bgneal@51 36
bgneal@51 37 # The encoding of source files.
bgneal@51 38 #source_encoding = 'utf-8-sig'
bgneal@51 39
bgneal@51 40 # The master toctree document.
bgneal@51 41 master_doc = 'index'
bgneal@51 42
bgneal@51 43 # General information about the project.
bgneal@51 44 project = 'm209'
bgneal@51 45 copyright = '2013, Brian Neal'
bgneal@51 46
bgneal@51 47 # The version info for the project you're documenting, acts as replacement for
bgneal@51 48 # |version| and |release|, also used in various other places throughout the
bgneal@51 49 # built documents.
bgneal@51 50 #
bgneal@51 51 # The short X.Y version.
bgneal@51 52 version = '0.1'
bgneal@51 53 # The full version, including alpha/beta/rc tags.
bgneal@51 54 release = '0.1'
bgneal@51 55
bgneal@51 56 # The language for content autogenerated by Sphinx. Refer to documentation
bgneal@51 57 # for a list of supported languages.
bgneal@51 58 #language = None
bgneal@51 59
bgneal@51 60 # There are two options for replacing |today|: either, you set today to some
bgneal@51 61 # non-false value, then it is used:
bgneal@51 62 #today = ''
bgneal@51 63 # Else, today_fmt is used as the format for a strftime call.
bgneal@51 64 #today_fmt = '%B %d, %Y'
bgneal@51 65
bgneal@51 66 # List of patterns, relative to source directory, that match files and
bgneal@51 67 # directories to ignore when looking for source files.
bgneal@51 68 exclude_patterns = ['_build']
bgneal@51 69
bgneal@51 70 # The reST default role (used for this markup: `text`) to use for all documents.
bgneal@51 71 #default_role = None
bgneal@51 72
bgneal@51 73 # If true, '()' will be appended to :func: etc. cross-reference text.
bgneal@51 74 #add_function_parentheses = True
bgneal@51 75
bgneal@51 76 # If true, the current module name will be prepended to all description
bgneal@51 77 # unit titles (such as .. function::).
bgneal@51 78 #add_module_names = True
bgneal@51 79
bgneal@51 80 # If true, sectionauthor and moduleauthor directives will be shown in the
bgneal@51 81 # output. They are ignored by default.
bgneal@51 82 #show_authors = False
bgneal@51 83
bgneal@51 84 # The name of the Pygments (syntax highlighting) style to use.
bgneal@51 85 pygments_style = 'sphinx'
bgneal@51 86
bgneal@51 87 # A list of ignored prefixes for module index sorting.
bgneal@51 88 #modindex_common_prefix = []
bgneal@51 89
bgneal@51 90 # If true, keep warnings as "system message" paragraphs in the built documents.
bgneal@51 91 #keep_warnings = False
bgneal@51 92
bgneal@51 93
bgneal@51 94 # -- Options for HTML output ---------------------------------------------------
bgneal@51 95
bgneal@51 96 # The theme to use for HTML and HTML Help pages. See the documentation for
bgneal@51 97 # a list of builtin themes.
bgneal@51 98 html_theme = 'default'
bgneal@51 99
bgneal@51 100 # Theme options are theme-specific and customize the look and feel of a theme
bgneal@51 101 # further. For a list of options available for each theme, see the
bgneal@51 102 # documentation.
bgneal@51 103 #html_theme_options = {}
bgneal@51 104
bgneal@51 105 # Add any paths that contain custom themes here, relative to this directory.
bgneal@51 106 #html_theme_path = []
bgneal@51 107
bgneal@51 108 # The name for this set of Sphinx documents. If None, it defaults to
bgneal@51 109 # "<project> v<release> documentation".
bgneal@51 110 #html_title = None
bgneal@51 111
bgneal@51 112 # A shorter title for the navigation bar. Default is the same as html_title.
bgneal@51 113 #html_short_title = None
bgneal@51 114
bgneal@51 115 # The name of an image file (relative to this directory) to place at the top
bgneal@51 116 # of the sidebar.
bgneal@51 117 #html_logo = None
bgneal@51 118
bgneal@51 119 # The name of an image file (within the static path) to use as favicon of the
bgneal@51 120 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
bgneal@51 121 # pixels large.
bgneal@51 122 #html_favicon = None
bgneal@51 123
bgneal@51 124 # Add any paths that contain custom static files (such as style sheets) here,
bgneal@51 125 # relative to this directory. They are copied after the builtin static files,
bgneal@51 126 # so a file named "default.css" will overwrite the builtin "default.css".
bgneal@51 127 html_static_path = ['_static']
bgneal@51 128
bgneal@51 129 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
bgneal@51 130 # using the given strftime format.
bgneal@51 131 #html_last_updated_fmt = '%b %d, %Y'
bgneal@51 132
bgneal@51 133 # If true, SmartyPants will be used to convert quotes and dashes to
bgneal@51 134 # typographically correct entities.
bgneal@51 135 #html_use_smartypants = True
bgneal@51 136
bgneal@51 137 # Custom sidebar templates, maps document names to template names.
bgneal@51 138 #html_sidebars = {}
bgneal@51 139
bgneal@51 140 # Additional templates that should be rendered to pages, maps page names to
bgneal@51 141 # template names.
bgneal@51 142 #html_additional_pages = {}
bgneal@51 143
bgneal@51 144 # If false, no module index is generated.
bgneal@51 145 #html_domain_indices = True
bgneal@51 146
bgneal@51 147 # If false, no index is generated.
bgneal@51 148 #html_use_index = True
bgneal@51 149
bgneal@51 150 # If true, the index is split into individual pages for each letter.
bgneal@51 151 #html_split_index = False
bgneal@51 152
bgneal@51 153 # If true, links to the reST sources are added to the pages.
bgneal@51 154 #html_show_sourcelink = True
bgneal@51 155
bgneal@51 156 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
bgneal@51 157 #html_show_sphinx = True
bgneal@51 158
bgneal@51 159 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
bgneal@51 160 #html_show_copyright = True
bgneal@51 161
bgneal@51 162 # If true, an OpenSearch description file will be output, and all pages will
bgneal@51 163 # contain a <link> tag referring to it. The value of this option must be the
bgneal@51 164 # base URL from which the finished HTML is served.
bgneal@51 165 #html_use_opensearch = ''
bgneal@51 166
bgneal@51 167 # This is the file name suffix for HTML files (e.g. ".xhtml").
bgneal@51 168 #html_file_suffix = None
bgneal@51 169
bgneal@51 170 # Output file base name for HTML help builder.
bgneal@51 171 htmlhelp_basename = 'm209doc'
bgneal@51 172
bgneal@51 173
bgneal@51 174 # -- Options for LaTeX output --------------------------------------------------
bgneal@51 175
bgneal@51 176 latex_elements = {
bgneal@51 177 # The paper size ('letterpaper' or 'a4paper').
bgneal@51 178 #'papersize': 'letterpaper',
bgneal@51 179
bgneal@51 180 # The font size ('10pt', '11pt' or '12pt').
bgneal@51 181 #'pointsize': '10pt',
bgneal@51 182
bgneal@51 183 # Additional stuff for the LaTeX preamble.
bgneal@51 184 #'preamble': '',
bgneal@51 185 }
bgneal@51 186
bgneal@51 187 # Grouping the document tree into LaTeX files. List of tuples
bgneal@51 188 # (source start file, target name, title, author, documentclass [howto/manual]).
bgneal@51 189 latex_documents = [
bgneal@51 190 ('index', 'm209.tex', 'm209 Documentation',
bgneal@51 191 'Brian Neal', 'manual'),
bgneal@51 192 ]
bgneal@51 193
bgneal@51 194 # The name of an image file (relative to this directory) to place at the top of
bgneal@51 195 # the title page.
bgneal@51 196 #latex_logo = None
bgneal@51 197
bgneal@51 198 # For "manual" documents, if this is true, then toplevel headings are parts,
bgneal@51 199 # not chapters.
bgneal@51 200 #latex_use_parts = False
bgneal@51 201
bgneal@51 202 # If true, show page references after internal links.
bgneal@51 203 #latex_show_pagerefs = False
bgneal@51 204
bgneal@51 205 # If true, show URL addresses after external links.
bgneal@51 206 #latex_show_urls = False
bgneal@51 207
bgneal@51 208 # Documents to append as an appendix to all manuals.
bgneal@51 209 #latex_appendices = []
bgneal@51 210
bgneal@51 211 # If false, no module index is generated.
bgneal@51 212 #latex_domain_indices = True
bgneal@51 213
bgneal@51 214
bgneal@51 215 # -- Options for manual page output --------------------------------------------
bgneal@51 216
bgneal@51 217 # One entry per manual page. List of tuples
bgneal@51 218 # (source start file, name, description, authors, manual section).
bgneal@51 219 man_pages = [
bgneal@51 220 ('index', 'm209', 'm209 Documentation',
bgneal@51 221 ['Brian Neal'], 1)
bgneal@51 222 ]
bgneal@51 223
bgneal@51 224 # If true, show URL addresses after external links.
bgneal@51 225 #man_show_urls = False
bgneal@51 226
bgneal@51 227
bgneal@51 228 # -- Options for Texinfo output ------------------------------------------------
bgneal@51 229
bgneal@51 230 # Grouping the document tree into Texinfo files. List of tuples
bgneal@51 231 # (source start file, target name, title, author,
bgneal@51 232 # dir menu entry, description, category)
bgneal@51 233 texinfo_documents = [
bgneal@51 234 ('index', 'm209', 'm209 Documentation',
bgneal@51 235 'Brian Neal', 'm209', 'One line description of project.',
bgneal@51 236 'Miscellaneous'),
bgneal@51 237 ]
bgneal@51 238
bgneal@51 239 # Documents to append as an appendix to all manuals.
bgneal@51 240 #texinfo_appendices = []
bgneal@51 241
bgneal@51 242 # If false, no module index is generated.
bgneal@51 243 #texinfo_domain_indices = True
bgneal@51 244
bgneal@51 245 # How to display URL addresses: 'footnote', 'no', or 'inline'.
bgneal@51 246 #texinfo_show_urls = 'footnote'
bgneal@51 247
bgneal@51 248 # If true, do not generate a @detailmenu in the "Top" node's menu.
bgneal@51 249 #texinfo_no_detailmenu = False