doxygen/html/conf_8py_source.html

00001 # -*- coding: utf-8 -*-
-00002 #
-00003 # cmd2 documentation build configuration file, created by
-00004 # sphinx-quickstart on Wed Feb 10 12:05:28 2010.
-00005 #
-00006 # This file is execfile()d with the current directory set to its containing dir.
-00007 #
-00008 # Note that not all possible configuration values are present in this
-00009 # autogenerated file.
-00010 #
-00011 # All configuration values have a default; values that are commented out
-00012 # serve to show the default.
-00013
-00014 import sys, os
-00015
-00016 # If extensions (or modules to document with autodoc) are in another directory,
-00017 # add these directories to sys.path here. If the directory is relative to the
-00018 # documentation root, use os.path.abspath to make it absolute, like shown here.
-00019 #sys.path.append(os.path.abspath('.'))
-00020
-00021 # -- General configuration -----------------------------------------------------
-00022
-00023 # Add any Sphinx extension module names here, as strings. They can be extensions
-00024 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-00025 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.todo']
-00026
-00027 # Add any paths that contain templates here, relative to this directory.
-00028 templates_path = ['_templates']
-00029
-00030 # The suffix of source filenames.
-00031 source_suffix = '.rst'
-00032
-00033 # The encoding of source files.
-00034 #source_encoding = 'utf-8'
-00035
-00036 # The master toctree document.
-00037 master_doc = 'index'
-00038
-00039 # General information about the project.
-00040 project = u'cmd2'
-00041 copyright = u'2010, Catherine Devlin'
-00042
-00043 # The version info for the project you're documenting, acts as replacement for
-00044 # |version| and |release|, also used in various other places throughout the
-00045 # built documents.
-00046 #
-00047 # The short X.Y version.
-00048 version = '0.6.0'
-00049 # The full version, including alpha/beta/rc tags.
-00050 release = '0.6.0'
-00051
-00052 # The language for content autogenerated by Sphinx. Refer to documentation
-00053 # for a list of supported languages.
-00054 #language = None
-00055
-00056 # There are two options for replacing |today|: either, you set today to some
-00057 # non-false value, then it is used:
-00058 #today = ''
-00059 # Else, today_fmt is used as the format for a strftime call.
-00060 #today_fmt = '%B %d, %Y'
-00061
-00062 # List of documents that shouldn't be included in the build.
-00063 #unused_docs = []
-00064
-00065 # List of directories, relative to source directory, that shouldn't be searched
-00066 # for source files.
-00067 exclude_trees = ['_build']
-00068
-00069 # The reST default role (used for this markup: `text`) to use for all documents.
-00070 #default_role = None
-00071
-00072 # If true, '()' will be appended to :func: etc. cross-reference text.
-00073 #add_function_parentheses = True
-00074
-00075 # If true, the current module name will be prepended to all description
-00076 # unit titles (such as .. function::).
-00077 #add_module_names = True
-00078
-00079 # If true, sectionauthor and moduleauthor directives will be shown in the
-00080 # output. They are ignored by default.
-00081 #show_authors = False
-00082
-00083 # The name of the Pygments (syntax highlighting) style to use.
-00084 pygments_style = 'sphinx'
-00085
-00086 # A list of ignored prefixes for module index sorting.
-00087 #modindex_common_prefix = []
-00088
-00089
-00090 # -- Options for HTML output ---------------------------------------------------
-00091
-00092 # The theme to use for HTML and HTML Help pages.  Major themes that come with
-00093 # Sphinx are currently 'default' and 'sphinxdoc'.
-00094 html_theme = 'default'
-00095
-00096 # Theme options are theme-specific and customize the look and feel of a theme
-00097 # further.  For a list of options available for each theme, see the
-00098 # documentation.
-00099 #html_theme_options = {}
-00100
-00101 # Add any paths that contain custom themes here, relative to this directory.
-00102 #html_theme_path = []
-00103
-00104 # The name for this set of Sphinx documents.  If None, it defaults to
-00105 # "<project> v<release> documentation".
-00106 #html_title = None
-00107
-00108 # A shorter title for the navigation bar.  Default is the same as html_title.
-00109 #html_short_title = None
-00110
-00111 # The name of an image file (relative to this directory) to place at the top
-00112 # of the sidebar.
-00113 #html_logo = None
-00114
-00115 # The name of an image file (within the static path) to use as favicon of the
-00116 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
-00117 # pixels large.
-00118 #html_favicon = None
-00119
-00120 # Add any paths that contain custom static files (such as style sheets) here,
-00121 # relative to this directory. They are copied after the builtin static files,
-00122 # so a file named "default.css" will overwrite the builtin "default.css".
-00123 html_static_path = ['_static']
-00124
-00125 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-00126 # using the given strftime format.
-00127 #html_last_updated_fmt = '%b %d, %Y'
-00128
-00129 # If true, SmartyPants will be used to convert quotes and dashes to
-00130 # typographically correct entities.
-00131 #html_use_smartypants = True
-00132
-00133 # Custom sidebar templates, maps document names to template names.
-00134 #html_sidebars = {}
-00135
-00136 # Additional templates that should be rendered to pages, maps page names to
-00137 # template names.
-00138 #html_additional_pages = {}
-00139
-00140 # If false, no module index is generated.
-00141 #html_use_modindex = True
-00142
-00143 # If false, no index is generated.
-00144 #html_use_index = True
-00145
-00146 # If true, the index is split into individual pages for each letter.
-00147 #html_split_index = False
-00148
-00149 # If true, links to the reST sources are added to the pages.
-00150 #html_show_sourcelink = True
-00151
-00152 # If true, an OpenSearch description file will be output, and all pages will
-00153 # contain a <link> tag referring to it.  The value of this option must be the
-00154 # base URL from which the finished HTML is served.
-00155 #html_use_opensearch = ''
-00156
-00157 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
-00158 #html_file_suffix = ''
-00159
-00160 # Output file base name for HTML help builder.
-00161 htmlhelp_basename = 'cmd2doc'
-00162
-00163
-00164 # -- Options for LaTeX output --------------------------------------------------
-00165
-00166 # The paper size ('letter' or 'a4').
-00167 #latex_paper_size = 'letter'
-00168
-00169 # The font size ('10pt', '11pt' or '12pt').
-00170 #latex_font_size = '10pt'
-00171
-00172 # Grouping the document tree into LaTeX files. List of tuples
-00173 # (source start file, target name, title, author, documentclass [howto/manual]).
-00174 latex_documents = [
-00175   ('index', 'cmd2.tex', u'cmd2 Documentation',
-00176    u'Catherine Devlin', 'manual'),
-00177 ]
-00178
-00179 # The name of an image file (relative to this directory) to place at the top of
-00180 # the title page.
-00181 #latex_logo = None
-00182
-00183 # For "manual" documents, if this is true, then toplevel headings are parts,
-00184 # not chapters.
-00185 #latex_use_parts = False
-00186
-00187 # Additional stuff for the LaTeX preamble.
-00188 #latex_preamble = ''
-00189
-00190 # Documents to append as an appendix to all manuals.
-00191 #latex_appendices = []
-00192
-00193 # If false, no module index is generated.
-00194 #latex_use_modindex = True
-00195
-00196
-00197 # Example configuration for intersphinx: refer to the Python standard library.
-00198 intersphinx_mapping = {'http://docs.python.org/': None}
-