bgneal@51: #!/usr/bin/env python3
bgneal@51: # -*- coding: utf-8 -*-
bgneal@51: #
bgneal@51: # m209 documentation build configuration file, created by
bgneal@51: # sphinx-quickstart on Thu Jul  4 18:12:07 2013.
bgneal@51: #
bgneal@51: # This file is execfile()d with the current directory set to its containing dir.
bgneal@51: #
bgneal@51: # Note that not all possible configuration values are present in this
bgneal@51: # autogenerated file.
bgneal@51: #
bgneal@51: # All configuration values have a default; values that are commented out
bgneal@51: # serve to show the default.
bgneal@51: 
bgneal@51: import sys, os
bgneal@51: 
bgneal@51: # If extensions (or modules to document with autodoc) are in another directory,
bgneal@51: # add these directories to sys.path here. If the directory is relative to the
bgneal@51: # documentation root, use os.path.abspath to make it absolute, like shown here.
bgneal@51: #sys.path.insert(0, os.path.abspath('.'))
bgneal@51: 
bgneal@51: # -- General configuration -----------------------------------------------------
bgneal@51: 
bgneal@51: # If your documentation needs a minimal Sphinx version, state it here.
bgneal@51: #needs_sphinx = '1.0'
bgneal@51: 
bgneal@51: # Add any Sphinx extension module names here, as strings. They can be extensions
bgneal@51: # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
bgneal@51: extensions = ['sphinx.ext.autodoc']
bgneal@51: 
bgneal@51: # Add any paths that contain templates here, relative to this directory.
bgneal@51: templates_path = ['_templates']
bgneal@51: 
bgneal@51: # The suffix of source filenames.
bgneal@51: source_suffix = '.rst'
bgneal@51: 
bgneal@51: # The encoding of source files.
bgneal@51: #source_encoding = 'utf-8-sig'
bgneal@51: 
bgneal@51: # The master toctree document.
bgneal@51: master_doc = 'index'
bgneal@51: 
bgneal@51: # General information about the project.
bgneal@51: project = 'm209'
bgneal@51: copyright = '2013, Brian Neal'
bgneal@51: 
bgneal@51: # The version info for the project you're documenting, acts as replacement for
bgneal@51: # |version| and |release|, also used in various other places throughout the
bgneal@51: # built documents.
bgneal@51: #
bgneal@51: # The short X.Y version.
bgneal@51: version = '0.1'
bgneal@51: # The full version, including alpha/beta/rc tags.
bgneal@51: release = '0.1'
bgneal@51: 
bgneal@51: # The language for content autogenerated by Sphinx. Refer to documentation
bgneal@51: # for a list of supported languages.
bgneal@51: #language = None
bgneal@51: 
bgneal@51: # There are two options for replacing |today|: either, you set today to some
bgneal@51: # non-false value, then it is used:
bgneal@51: #today = ''
bgneal@51: # Else, today_fmt is used as the format for a strftime call.
bgneal@51: #today_fmt = '%B %d, %Y'
bgneal@51: 
bgneal@51: # List of patterns, relative to source directory, that match files and
bgneal@51: # directories to ignore when looking for source files.
bgneal@51: exclude_patterns = ['_build']
bgneal@51: 
bgneal@51: # The reST default role (used for this markup: `text`) to use for all documents.
bgneal@51: #default_role = None
bgneal@51: 
bgneal@51: # If true, '()' will be appended to :func: etc. cross-reference text.
bgneal@51: #add_function_parentheses = True
bgneal@51: 
bgneal@51: # If true, the current module name will be prepended to all description
bgneal@51: # unit titles (such as .. function::).
bgneal@51: #add_module_names = True
bgneal@51: 
bgneal@51: # If true, sectionauthor and moduleauthor directives will be shown in the
bgneal@51: # output. They are ignored by default.
bgneal@51: #show_authors = False
bgneal@51: 
bgneal@51: # The name of the Pygments (syntax highlighting) style to use.
bgneal@51: pygments_style = 'sphinx'
bgneal@51: 
bgneal@51: # A list of ignored prefixes for module index sorting.
bgneal@51: #modindex_common_prefix = []
bgneal@51: 
bgneal@51: # If true, keep warnings as "system message" paragraphs in the built documents.
bgneal@51: #keep_warnings = False
bgneal@51: 
bgneal@51: 
bgneal@51: # -- Options for HTML output ---------------------------------------------------
bgneal@51: 
bgneal@51: # The theme to use for HTML and HTML Help pages.  See the documentation for
bgneal@51: # a list of builtin themes.
bgneal@51: html_theme = 'default'
bgneal@51: 
bgneal@51: # Theme options are theme-specific and customize the look and feel of a theme
bgneal@51: # further.  For a list of options available for each theme, see the
bgneal@51: # documentation.
bgneal@51: #html_theme_options = {}
bgneal@51: 
bgneal@51: # Add any paths that contain custom themes here, relative to this directory.
bgneal@51: #html_theme_path = []
bgneal@51: 
bgneal@51: # The name for this set of Sphinx documents.  If None, it defaults to
bgneal@51: # "<project> v<release> documentation".
bgneal@51: #html_title = None
bgneal@51: 
bgneal@51: # A shorter title for the navigation bar.  Default is the same as html_title.
bgneal@51: #html_short_title = None
bgneal@51: 
bgneal@51: # The name of an image file (relative to this directory) to place at the top
bgneal@51: # of the sidebar.
bgneal@51: #html_logo = None
bgneal@51: 
bgneal@51: # The name of an image file (within the static path) to use as favicon of the
bgneal@51: # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
bgneal@51: # pixels large.
bgneal@51: #html_favicon = None
bgneal@51: 
bgneal@51: # Add any paths that contain custom static files (such as style sheets) here,
bgneal@51: # relative to this directory. They are copied after the builtin static files,
bgneal@51: # so a file named "default.css" will overwrite the builtin "default.css".
bgneal@51: html_static_path = ['_static']
bgneal@51: 
bgneal@51: # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
bgneal@51: # using the given strftime format.
bgneal@51: #html_last_updated_fmt = '%b %d, %Y'
bgneal@51: 
bgneal@51: # If true, SmartyPants will be used to convert quotes and dashes to
bgneal@51: # typographically correct entities.
bgneal@51: #html_use_smartypants = True
bgneal@51: 
bgneal@51: # Custom sidebar templates, maps document names to template names.
bgneal@51: #html_sidebars = {}
bgneal@51: 
bgneal@51: # Additional templates that should be rendered to pages, maps page names to
bgneal@51: # template names.
bgneal@51: #html_additional_pages = {}
bgneal@51: 
bgneal@51: # If false, no module index is generated.
bgneal@51: #html_domain_indices = True
bgneal@51: 
bgneal@51: # If false, no index is generated.
bgneal@51: #html_use_index = True
bgneal@51: 
bgneal@51: # If true, the index is split into individual pages for each letter.
bgneal@51: #html_split_index = False
bgneal@51: 
bgneal@51: # If true, links to the reST sources are added to the pages.
bgneal@51: #html_show_sourcelink = True
bgneal@51: 
bgneal@51: # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
bgneal@51: #html_show_sphinx = True
bgneal@51: 
bgneal@51: # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
bgneal@51: #html_show_copyright = True
bgneal@51: 
bgneal@51: # If true, an OpenSearch description file will be output, and all pages will
bgneal@51: # contain a <link> tag referring to it.  The value of this option must be the
bgneal@51: # base URL from which the finished HTML is served.
bgneal@51: #html_use_opensearch = ''
bgneal@51: 
bgneal@51: # This is the file name suffix for HTML files (e.g. ".xhtml").
bgneal@51: #html_file_suffix = None
bgneal@51: 
bgneal@51: # Output file base name for HTML help builder.
bgneal@51: htmlhelp_basename = 'm209doc'
bgneal@51: 
bgneal@51: 
bgneal@51: # -- Options for LaTeX output --------------------------------------------------
bgneal@51: 
bgneal@51: latex_elements = {
bgneal@51: # The paper size ('letterpaper' or 'a4paper').
bgneal@51: #'papersize': 'letterpaper',
bgneal@51: 
bgneal@51: # The font size ('10pt', '11pt' or '12pt').
bgneal@51: #'pointsize': '10pt',
bgneal@51: 
bgneal@51: # Additional stuff for the LaTeX preamble.
bgneal@51: #'preamble': '',
bgneal@51: }
bgneal@51: 
bgneal@51: # Grouping the document tree into LaTeX files. List of tuples
bgneal@51: # (source start file, target name, title, author, documentclass [howto/manual]).
bgneal@51: latex_documents = [
bgneal@51:   ('index', 'm209.tex', 'm209 Documentation',
bgneal@51:    'Brian Neal', 'manual'),
bgneal@51: ]
bgneal@51: 
bgneal@51: # The name of an image file (relative to this directory) to place at the top of
bgneal@51: # the title page.
bgneal@51: #latex_logo = None
bgneal@51: 
bgneal@51: # For "manual" documents, if this is true, then toplevel headings are parts,
bgneal@51: # not chapters.
bgneal@51: #latex_use_parts = False
bgneal@51: 
bgneal@51: # If true, show page references after internal links.
bgneal@51: #latex_show_pagerefs = False
bgneal@51: 
bgneal@51: # If true, show URL addresses after external links.
bgneal@51: #latex_show_urls = False
bgneal@51: 
bgneal@51: # Documents to append as an appendix to all manuals.
bgneal@51: #latex_appendices = []
bgneal@51: 
bgneal@51: # If false, no module index is generated.
bgneal@51: #latex_domain_indices = True
bgneal@51: 
bgneal@51: 
bgneal@51: # -- Options for manual page output --------------------------------------------
bgneal@51: 
bgneal@51: # One entry per manual page. List of tuples
bgneal@51: # (source start file, name, description, authors, manual section).
bgneal@51: man_pages = [
bgneal@51:     ('index', 'm209', 'm209 Documentation',
bgneal@51:      ['Brian Neal'], 1)
bgneal@51: ]
bgneal@51: 
bgneal@51: # If true, show URL addresses after external links.
bgneal@51: #man_show_urls = False
bgneal@51: 
bgneal@51: 
bgneal@51: # -- Options for Texinfo output ------------------------------------------------
bgneal@51: 
bgneal@51: # Grouping the document tree into Texinfo files. List of tuples
bgneal@51: # (source start file, target name, title, author,
bgneal@51: #  dir menu entry, description, category)
bgneal@51: texinfo_documents = [
bgneal@51:   ('index', 'm209', 'm209 Documentation',
bgneal@51:    'Brian Neal', 'm209', 'One line description of project.',
bgneal@51:    'Miscellaneous'),
bgneal@51: ]
bgneal@51: 
bgneal@51: # Documents to append as an appendix to all manuals.
bgneal@51: #texinfo_appendices = []
bgneal@51: 
bgneal@51: # If false, no module index is generated.
bgneal@51: #texinfo_domain_indices = True
bgneal@51: 
bgneal@51: # How to display URL addresses: 'footnote', 'no', or 'inline'.
bgneal@51: #texinfo_show_urls = 'footnote'
bgneal@51: 
bgneal@51: # If true, do not generate a @detailmenu in the "Top" node's menu.
bgneal@51: #texinfo_no_detailmenu = False