diff options
Diffstat (limited to 'doxygen/html/conf_8py_source.html')
| -rw-r--r-- | doxygen/html/conf_8py_source.html | 326 |
1 files changed, 326 insertions, 0 deletions
diff --git a/doxygen/html/conf_8py_source.html b/doxygen/html/conf_8py_source.html new file mode 100644 index 0000000..d113545 --- /dev/null +++ b/doxygen/html/conf_8py_source.html @@ -0,0 +1,326 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<title>Cmd2: /Users/amrogers/Developer/Projects/cmd2/docs/conf.py Source File</title> + +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +<link href="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); +</script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</script> + +</head> +<body> +<div id="top"><!-- do not remove this div! --> + + +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + + + <td style="padding-left: 0.5em;"> + <div id="projectname">Cmd2 + + </div> + + </td> + + + + </tr> + </tbody> +</table> +</div> + +<!-- Generated by Doxygen 1.7.5.1 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="namespaces.html"><span>Packages</span></a></li> + <li><a href="annotated.html"><span>Classes</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + <li><a href="dirs.html"><span>Directories</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="files.html"><span>File List</span></a></li> + </ul> + </div> +</div> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> + initNavTree('conf_8py.html',''); +</script> +<div id="doc-content"> +<div class="header"> + <div class="headertitle"> +<div class="title">conf.py</div> </div> +</div> +<div class="contents"> +<a href="conf_8py.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a><a class="code" href="namespaceconf.html">00001</a> <span class="comment"># -*- coding: utf-8 -*-</span> +<a name="l00002"></a>00002 <span class="comment">#</span> +<a name="l00003"></a>00003 <span class="comment"># cmd2 documentation build configuration file, created by</span> +<a name="l00004"></a>00004 <span class="comment"># sphinx-quickstart on Wed Feb 10 12:05:28 2010.</span> +<a name="l00005"></a>00005 <span class="comment">#</span> +<a name="l00006"></a>00006 <span class="comment"># This file is execfile()d with the current directory set to its containing dir.</span> +<a name="l00007"></a>00007 <span class="comment">#</span> +<a name="l00008"></a>00008 <span class="comment"># Note that not all possible configuration values are present in this</span> +<a name="l00009"></a>00009 <span class="comment"># autogenerated file.</span> +<a name="l00010"></a>00010 <span class="comment">#</span> +<a name="l00011"></a>00011 <span class="comment"># All configuration values have a default; values that are commented out</span> +<a name="l00012"></a>00012 <span class="comment"># serve to show the default.</span> +<a name="l00013"></a>00013 +<a name="l00014"></a>00014 <span class="keyword">import</span> sys, os +<a name="l00015"></a>00015 +<a name="l00016"></a>00016 <span class="comment"># If extensions (or modules to document with autodoc) are in another directory,</span> +<a name="l00017"></a>00017 <span class="comment"># add these directories to sys.path here. If the directory is relative to the</span> +<a name="l00018"></a>00018 <span class="comment"># documentation root, use os.path.abspath to make it absolute, like shown here.</span> +<a name="l00019"></a>00019 <span class="comment">#sys.path.append(os.path.abspath('.'))</span> +<a name="l00020"></a>00020 +<a name="l00021"></a>00021 <span class="comment"># -- General configuration -----------------------------------------------------</span> +<a name="l00022"></a>00022 +<a name="l00023"></a>00023 <span class="comment"># Add any Sphinx extension module names here, as strings. They can be extensions</span> +<a name="l00024"></a>00024 <span class="comment"># coming with Sphinx (named 'sphinx.ext.*') or your custom ones.</span> +<a name="l00025"></a><a class="code" href="namespaceconf.html#a540efa67c53e84c1c353c1df2e37e39c">00025</a> extensions = [<span class="stringliteral">'sphinx.ext.autodoc'</span>, <span class="stringliteral">'sphinx.ext.doctest'</span>, <span class="stringliteral">'sphinx.ext.intersphinx'</span>, <span class="stringliteral">'sphinx.ext.todo'</span>] +<a name="l00026"></a>00026 +<a name="l00027"></a>00027 <span class="comment"># Add any paths that contain templates here, relative to this directory.</span> +<a name="l00028"></a><a class="code" href="namespaceconf.html#af50129dcc1f90655539f025595a3093b">00028</a> templates_path = [<span class="stringliteral">'_templates'</span>] +<a name="l00029"></a>00029 +<a name="l00030"></a>00030 <span class="comment"># The suffix of source filenames.</span> +<a name="l00031"></a><a class="code" href="namespaceconf.html#a1e0ba7f4cb1d50fa831f1236a77d60f6">00031</a> source_suffix = <span class="stringliteral">'.rst'</span> +<a name="l00032"></a>00032 +<a name="l00033"></a>00033 <span class="comment"># The encoding of source files.</span> +<a name="l00034"></a>00034 <span class="comment">#source_encoding = 'utf-8'</span> +<a name="l00035"></a>00035 +<a name="l00036"></a>00036 <span class="comment"># The master toctree document.</span> +<a name="l00037"></a><a class="code" href="namespaceconf.html#ae22a29d94a222730836db739d6dbd71e">00037</a> master_doc = <span class="stringliteral">'index'</span> +<a name="l00038"></a>00038 +<a name="l00039"></a>00039 <span class="comment"># General information about the project.</span> +<a name="l00040"></a><a class="code" href="namespaceconf.html#aa2c6aefbed1597a70cfb45a760e5977c">00040</a> project = <span class="stringliteral">u'cmd2'</span> +<a name="l00041"></a><a class="code" href="namespaceconf.html#ac8ccf456b321bc9052c0691a173b6925">00041</a> copyright = <span class="stringliteral">u'2010, Catherine Devlin'</span> +<a name="l00042"></a>00042 +<a name="l00043"></a>00043 <span class="comment"># The version info for the project you're documenting, acts as replacement for</span> +<a name="l00044"></a>00044 <span class="comment"># |version| and |release|, also used in various other places throughout the</span> +<a name="l00045"></a>00045 <span class="comment"># built documents.</span> +<a name="l00046"></a>00046 <span class="comment">#</span> +<a name="l00047"></a>00047 <span class="comment"># The short X.Y version.</span> +<a name="l00048"></a><a class="code" href="namespaceconf.html#a93370314d5e59e93dabf67ca4906c634">00048</a> version = <span class="stringliteral">'0.6.0'</span> +<a name="l00049"></a>00049 <span class="comment"># The full version, including alpha/beta/rc tags.</span> +<a name="l00050"></a><a class="code" href="namespaceconf.html#a90a599726178800ad5a42f6bc2cd5208">00050</a> release = <span class="stringliteral">'0.6.0'</span> +<a name="l00051"></a>00051 +<a name="l00052"></a>00052 <span class="comment"># The language for content autogenerated by Sphinx. Refer to documentation</span> +<a name="l00053"></a>00053 <span class="comment"># for a list of supported languages.</span> +<a name="l00054"></a>00054 <span class="comment">#language = None</span> +<a name="l00055"></a>00055 +<a name="l00056"></a>00056 <span class="comment"># There are two options for replacing |today|: either, you set today to some</span> +<a name="l00057"></a>00057 <span class="comment"># non-false value, then it is used:</span> +<a name="l00058"></a>00058 <span class="comment">#today = ''</span> +<a name="l00059"></a>00059 <span class="comment"># Else, today_fmt is used as the format for a strftime call.</span> +<a name="l00060"></a>00060 <span class="comment">#today_fmt = '%B %d, %Y'</span> +<a name="l00061"></a>00061 +<a name="l00062"></a>00062 <span class="comment"># List of documents that shouldn't be included in the build.</span> +<a name="l00063"></a>00063 <span class="comment">#unused_docs = []</span> +<a name="l00064"></a>00064 +<a name="l00065"></a>00065 <span class="comment"># List of directories, relative to source directory, that shouldn't be searched</span> +<a name="l00066"></a>00066 <span class="comment"># for source files.</span> +<a name="l00067"></a><a class="code" href="namespaceconf.html#acfb345e27f5356b8778ab7b673e72556">00067</a> exclude_trees = [<span class="stringliteral">'_build'</span>] +<a name="l00068"></a>00068 +<a name="l00069"></a>00069 <span class="comment"># The reST default role (used for this markup: `text`) to use for all documents.</span> +<a name="l00070"></a>00070 <span class="comment">#default_role = None</span> +<a name="l00071"></a>00071 +<a name="l00072"></a>00072 <span class="comment"># If true, '()' will be appended to :func: etc. cross-reference text.</span> +<a name="l00073"></a>00073 <span class="comment">#add_function_parentheses = True</span> +<a name="l00074"></a>00074 +<a name="l00075"></a>00075 <span class="comment"># If true, the current module name will be prepended to all description</span> +<a name="l00076"></a>00076 <span class="comment"># unit titles (such as .. function::).</span> +<a name="l00077"></a>00077 <span class="comment">#add_module_names = True</span> +<a name="l00078"></a>00078 +<a name="l00079"></a>00079 <span class="comment"># If true, sectionauthor and moduleauthor directives will be shown in the</span> +<a name="l00080"></a>00080 <span class="comment"># output. They are ignored by default.</span> +<a name="l00081"></a>00081 <span class="comment">#show_authors = False</span> +<a name="l00082"></a>00082 +<a name="l00083"></a>00083 <span class="comment"># The name of the Pygments (syntax highlighting) style to use.</span> +<a name="l00084"></a><a class="code" href="namespaceconf.html#afa4e4ed164119ef5f4656e9554ed1f1b">00084</a> pygments_style = <span class="stringliteral">'sphinx'</span> +<a name="l00085"></a>00085 +<a name="l00086"></a>00086 <span class="comment"># A list of ignored prefixes for module index sorting.</span> +<a name="l00087"></a>00087 <span class="comment">#modindex_common_prefix = []</span> +<a name="l00088"></a>00088 +<a name="l00089"></a>00089 +<a name="l00090"></a>00090 <span class="comment"># -- Options for HTML output ---------------------------------------------------</span> +<a name="l00091"></a>00091 +<a name="l00092"></a>00092 <span class="comment"># The theme to use for HTML and HTML Help pages. Major themes that come with</span> +<a name="l00093"></a>00093 <span class="comment"># Sphinx are currently 'default' and 'sphinxdoc'.</span> +<a name="l00094"></a><a class="code" href="namespaceconf.html#a7f1b143ff25817758abd21a7db110510">00094</a> html_theme = <span class="stringliteral">'default'</span> +<a name="l00095"></a>00095 +<a name="l00096"></a>00096 <span class="comment"># Theme options are theme-specific and customize the look and feel of a theme</span> +<a name="l00097"></a>00097 <span class="comment"># further. For a list of options available for each theme, see the</span> +<a name="l00098"></a>00098 <span class="comment"># documentation.</span> +<a name="l00099"></a>00099 <span class="comment">#html_theme_options = {}</span> +<a name="l00100"></a>00100 +<a name="l00101"></a>00101 <span class="comment"># Add any paths that contain custom themes here, relative to this directory.</span> +<a name="l00102"></a>00102 <span class="comment">#html_theme_path = []</span> +<a name="l00103"></a>00103 +<a name="l00104"></a>00104 <span class="comment"># The name for this set of Sphinx documents. If None, it defaults to</span> +<a name="l00105"></a>00105 <span class="comment"># "<project> v<release> documentation".</span> +<a name="l00106"></a>00106 <span class="comment">#html_title = None</span> +<a name="l00107"></a>00107 +<a name="l00108"></a>00108 <span class="comment"># A shorter title for the navigation bar. Default is the same as html_title.</span> +<a name="l00109"></a>00109 <span class="comment">#html_short_title = None</span> +<a name="l00110"></a>00110 +<a name="l00111"></a>00111 <span class="comment"># The name of an image file (relative to this directory) to place at the top</span> +<a name="l00112"></a>00112 <span class="comment"># of the sidebar.</span> +<a name="l00113"></a>00113 <span class="comment">#html_logo = None</span> +<a name="l00114"></a>00114 +<a name="l00115"></a>00115 <span class="comment"># The name of an image file (within the static path) to use as favicon of the</span> +<a name="l00116"></a>00116 <span class="comment"># docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32</span> +<a name="l00117"></a>00117 <span class="comment"># pixels large.</span> +<a name="l00118"></a>00118 <span class="comment">#html_favicon = None</span> +<a name="l00119"></a>00119 +<a name="l00120"></a>00120 <span class="comment"># Add any paths that contain custom static files (such as style sheets) here,</span> +<a name="l00121"></a>00121 <span class="comment"># relative to this directory. They are copied after the builtin static files,</span> +<a name="l00122"></a>00122 <span class="comment"># so a file named "default.css" will overwrite the builtin "default.css".</span> +<a name="l00123"></a><a class="code" href="namespaceconf.html#acb91fefcfd3aa6f3529fa682ab834832">00123</a> html_static_path = [<span class="stringliteral">'_static'</span>] +<a name="l00124"></a>00124 +<a name="l00125"></a>00125 <span class="comment"># If not '', a 'Last updated on:' timestamp is inserted at every page bottom,</span> +<a name="l00126"></a>00126 <span class="comment"># using the given strftime format.</span> +<a name="l00127"></a>00127 <span class="comment">#html_last_updated_fmt = '%b %d, %Y'</span> +<a name="l00128"></a>00128 +<a name="l00129"></a>00129 <span class="comment"># If true, SmartyPants will be used to convert quotes and dashes to</span> +<a name="l00130"></a>00130 <span class="comment"># typographically correct entities.</span> +<a name="l00131"></a>00131 <span class="comment">#html_use_smartypants = True</span> +<a name="l00132"></a>00132 +<a name="l00133"></a>00133 <span class="comment"># Custom sidebar templates, maps document names to template names.</span> +<a name="l00134"></a>00134 <span class="comment">#html_sidebars = {}</span> +<a name="l00135"></a>00135 +<a name="l00136"></a>00136 <span class="comment"># Additional templates that should be rendered to pages, maps page names to</span> +<a name="l00137"></a>00137 <span class="comment"># template names.</span> +<a name="l00138"></a>00138 <span class="comment">#html_additional_pages = {}</span> +<a name="l00139"></a>00139 +<a name="l00140"></a>00140 <span class="comment"># If false, no module index is generated.</span> +<a name="l00141"></a>00141 <span class="comment">#html_use_modindex = True</span> +<a name="l00142"></a>00142 +<a name="l00143"></a>00143 <span class="comment"># If false, no index is generated.</span> +<a name="l00144"></a>00144 <span class="comment">#html_use_index = True</span> +<a name="l00145"></a>00145 +<a name="l00146"></a>00146 <span class="comment"># If true, the index is split into individual pages for each letter.</span> +<a name="l00147"></a>00147 <span class="comment">#html_split_index = False</span> +<a name="l00148"></a>00148 +<a name="l00149"></a>00149 <span class="comment"># If true, links to the reST sources are added to the pages.</span> +<a name="l00150"></a>00150 <span class="comment">#html_show_sourcelink = True</span> +<a name="l00151"></a>00151 +<a name="l00152"></a>00152 <span class="comment"># If true, an OpenSearch description file will be output, and all pages will</span> +<a name="l00153"></a>00153 <span class="comment"># contain a <link> tag referring to it. The value of this option must be the</span> +<a name="l00154"></a>00154 <span class="comment"># base URL from which the finished HTML is served.</span> +<a name="l00155"></a>00155 <span class="comment">#html_use_opensearch = ''</span> +<a name="l00156"></a>00156 +<a name="l00157"></a>00157 <span class="comment"># If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").</span> +<a name="l00158"></a>00158 <span class="comment">#html_file_suffix = ''</span> +<a name="l00159"></a>00159 +<a name="l00160"></a>00160 <span class="comment"># Output file base name for HTML help builder.</span> +<a name="l00161"></a><a class="code" href="namespaceconf.html#a74d707b34bba474e9057f383ad01de83">00161</a> htmlhelp_basename = <span class="stringliteral">'cmd2doc'</span> +<a name="l00162"></a>00162 +<a name="l00163"></a>00163 +<a name="l00164"></a>00164 <span class="comment"># -- Options for LaTeX output --------------------------------------------------</span> +<a name="l00165"></a>00165 +<a name="l00166"></a>00166 <span class="comment"># The paper size ('letter' or 'a4').</span> +<a name="l00167"></a>00167 <span class="comment">#latex_paper_size = 'letter'</span> +<a name="l00168"></a>00168 +<a name="l00169"></a>00169 <span class="comment"># The font size ('10pt', '11pt' or '12pt').</span> +<a name="l00170"></a>00170 <span class="comment">#latex_font_size = '10pt'</span> +<a name="l00171"></a>00171 +<a name="l00172"></a>00172 <span class="comment"># Grouping the document tree into LaTeX files. List of tuples</span> +<a name="l00173"></a>00173 <span class="comment"># (source start file, target name, title, author, documentclass [howto/manual]).</span> +<a name="l00174"></a><a class="code" href="namespaceconf.html#a00b7896473527f894006130b1113cb4b">00174</a> latex_documents = [ +<a name="l00175"></a>00175 (<span class="stringliteral">'index'</span>, <span class="stringliteral">'cmd2.tex'</span>, <span class="stringliteral">u'cmd2 Documentation'</span>, +<a name="l00176"></a>00176 <span class="stringliteral">u'Catherine Devlin'</span>, <span class="stringliteral">'manual'</span>), +<a name="l00177"></a>00177 ] +<a name="l00178"></a>00178 +<a name="l00179"></a>00179 <span class="comment"># The name of an image file (relative to this directory) to place at the top of</span> +<a name="l00180"></a>00180 <span class="comment"># the title page.</span> +<a name="l00181"></a>00181 <span class="comment">#latex_logo = None</span> +<a name="l00182"></a>00182 +<a name="l00183"></a>00183 <span class="comment"># For "manual" documents, if this is true, then toplevel headings are parts,</span> +<a name="l00184"></a>00184 <span class="comment"># not chapters.</span> +<a name="l00185"></a>00185 <span class="comment">#latex_use_parts = False</span> +<a name="l00186"></a>00186 +<a name="l00187"></a>00187 <span class="comment"># Additional stuff for the LaTeX preamble.</span> +<a name="l00188"></a>00188 <span class="comment">#latex_preamble = ''</span> +<a name="l00189"></a>00189 +<a name="l00190"></a>00190 <span class="comment"># Documents to append as an appendix to all manuals.</span> +<a name="l00191"></a>00191 <span class="comment">#latex_appendices = []</span> +<a name="l00192"></a>00192 +<a name="l00193"></a>00193 <span class="comment"># If false, no module index is generated.</span> +<a name="l00194"></a>00194 <span class="comment">#latex_use_modindex = True</span> +<a name="l00195"></a>00195 +<a name="l00196"></a>00196 +<a name="l00197"></a>00197 <span class="comment"># Example configuration for intersphinx: refer to the Python standard library.</span> +<a name="l00198"></a><a class="code" href="namespaceconf.html#a9d1981d8fc4e2521d62ffc607e3ef8f2">00198</a> intersphinx_mapping = {<span class="stringliteral">'http://docs.python.org/'</span>: <span class="keywordtype">None</span>} +</pre></div></div> +</div> + <div id="nav-path" class="navpath"> + <ul> + <li class="navelem"><a class="el" href="conf_8py.html">conf.py</a> </li> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a></div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + + + <li class="footer">Generated on Fri Sep 9 2011 10:50:47 for Cmd2 by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li> + </ul> + </div> + + +</body> +</html> |