diff options
Diffstat (limited to 'doxygen/xml/conf_8py.xml')
| -rw-r--r-- | doxygen/xml/conf_8py.xml | 212 |
1 files changed, 0 insertions, 212 deletions
diff --git a/doxygen/xml/conf_8py.xml b/doxygen/xml/conf_8py.xml deleted file mode 100644 index 9e220d0..0000000 --- a/doxygen/xml/conf_8py.xml +++ /dev/null @@ -1,212 +0,0 @@ -<?xml version='1.0' encoding='UTF-8' standalone='no'?> -<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.7.5.1"> - <compounddef id="conf_8py" kind="file"> - <compoundname>conf.py</compoundname> - <innernamespace refid="namespaceconf">conf</innernamespace> - <briefdescription> - </briefdescription> - <detaileddescription> - </detaileddescription> - <programlisting> -<codeline lineno="1" refid="namespaceconf" refkind="compound"><highlight class="comment">#<sp/>-*-<sp/>coding:<sp/>utf-8<sp/>-*-</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="2"><highlight class="normal"></highlight><highlight class="comment">#</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="3"><highlight class="normal"></highlight><highlight class="comment">#<sp/>cmd2<sp/>documentation<sp/>build<sp/>configuration<sp/>file,<sp/>created<sp/>by</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="4"><highlight class="normal"></highlight><highlight class="comment">#<sp/>sphinx-quickstart<sp/>on<sp/>Wed<sp/>Feb<sp/>10<sp/>12:05:28<sp/>2010.</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="5"><highlight class="normal"></highlight><highlight class="comment">#</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="6"><highlight class="normal"></highlight><highlight class="comment">#<sp/>This<sp/>file<sp/>is<sp/>execfile()d<sp/>with<sp/>the<sp/>current<sp/>directory<sp/>set<sp/>to<sp/>its<sp/>containing<sp/>dir.</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="7"><highlight class="normal"></highlight><highlight class="comment">#</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="8"><highlight class="normal"></highlight><highlight class="comment">#<sp/>Note<sp/>that<sp/>not<sp/>all<sp/>possible<sp/>configuration<sp/>values<sp/>are<sp/>present<sp/>in<sp/>this</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="9"><highlight class="normal"></highlight><highlight class="comment">#<sp/>autogenerated<sp/>file.</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="10"><highlight class="normal"></highlight><highlight class="comment">#</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="11"><highlight class="normal"></highlight><highlight class="comment">#<sp/>All<sp/>configuration<sp/>values<sp/>have<sp/>a<sp/>default;<sp/>values<sp/>that<sp/>are<sp/>commented<sp/>out</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="12"><highlight class="normal"></highlight><highlight class="comment">#<sp/>serve<sp/>to<sp/>show<sp/>the<sp/>default.</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="13"><highlight class="normal"></highlight></codeline> -<codeline lineno="14"><highlight class="normal"></highlight><highlight class="keyword">import</highlight><highlight class="normal"><sp/>sys,<sp/>os</highlight></codeline> -<codeline lineno="15"><highlight class="normal"></highlight></codeline> -<codeline lineno="16"><highlight class="normal"></highlight><highlight class="comment">#<sp/>If<sp/>extensions<sp/>(or<sp/>modules<sp/>to<sp/>document<sp/>with<sp/>autodoc)<sp/>are<sp/>in<sp/>another<sp/>directory,</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="17"><highlight class="normal"></highlight><highlight class="comment">#<sp/>add<sp/>these<sp/>directories<sp/>to<sp/>sys.path<sp/>here.<sp/>If<sp/>the<sp/>directory<sp/>is<sp/>relative<sp/>to<sp/>the</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="18"><highlight class="normal"></highlight><highlight class="comment">#<sp/>documentation<sp/>root,<sp/>use<sp/>os.path.abspath<sp/>to<sp/>make<sp/>it<sp/>absolute,<sp/>like<sp/>shown<sp/>here.</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="19"><highlight class="normal"></highlight><highlight class="comment">#sys.path.append(os.path.abspath('.'))</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="20"><highlight class="normal"></highlight></codeline> -<codeline lineno="21"><highlight class="normal"></highlight><highlight class="comment">#<sp/>--<sp/>General<sp/>configuration<sp/>-----------------------------------------------------</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="22"><highlight class="normal"></highlight></codeline> -<codeline lineno="23"><highlight class="normal"></highlight><highlight class="comment">#<sp/>Add<sp/>any<sp/>Sphinx<sp/>extension<sp/>module<sp/>names<sp/>here,<sp/>as<sp/>strings.<sp/>They<sp/>can<sp/>be<sp/>extensions</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="24"><highlight class="normal"></highlight><highlight class="comment">#<sp/>coming<sp/>with<sp/>Sphinx<sp/>(named<sp/>'sphinx.ext.*')<sp/>or<sp/>your<sp/>custom<sp/>ones.</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="25" refid="namespaceconf_1a540efa67c53e84c1c353c1df2e37e39c" refkind="member"><highlight class="normal">extensions<sp/>=<sp/>[</highlight><highlight class="stringliteral">'sphinx.ext.autodoc'</highlight><highlight class="normal">,<sp/></highlight><highlight class="stringliteral">'sphinx.ext.doctest'</highlight><highlight class="normal">,<sp/></highlight><highlight class="stringliteral">'sphinx.ext.intersphinx'</highlight><highlight class="normal">,<sp/></highlight><highlight class="stringliteral">'sphinx.ext.todo'</highlight><highlight class="normal">]</highlight></codeline> -<codeline lineno="26"><highlight class="normal"></highlight></codeline> -<codeline lineno="27"><highlight class="normal"></highlight><highlight class="comment">#<sp/>Add<sp/>any<sp/>paths<sp/>that<sp/>contain<sp/>templates<sp/>here,<sp/>relative<sp/>to<sp/>this<sp/>directory.</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="28" refid="namespaceconf_1af50129dcc1f90655539f025595a3093b" refkind="member"><highlight class="normal">templates_path<sp/>=<sp/>[</highlight><highlight class="stringliteral">'_templates'</highlight><highlight class="normal">]</highlight></codeline> -<codeline lineno="29"><highlight class="normal"></highlight></codeline> -<codeline lineno="30"><highlight class="normal"></highlight><highlight class="comment">#<sp/>The<sp/>suffix<sp/>of<sp/>source<sp/>filenames.</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="31" refid="namespaceconf_1a1e0ba7f4cb1d50fa831f1236a77d60f6" refkind="member"><highlight class="normal">source_suffix<sp/>=<sp/></highlight><highlight class="stringliteral">'.rst'</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="32"><highlight class="normal"></highlight></codeline> -<codeline lineno="33"><highlight class="normal"></highlight><highlight class="comment">#<sp/>The<sp/>encoding<sp/>of<sp/>source<sp/>files.</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="34"><highlight class="normal"></highlight><highlight class="comment">#source_encoding<sp/>=<sp/>'utf-8'</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="35"><highlight class="normal"></highlight></codeline> -<codeline lineno="36"><highlight class="normal"></highlight><highlight class="comment">#<sp/>The<sp/>master<sp/>toctree<sp/>document.</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="37" refid="namespaceconf_1ae22a29d94a222730836db739d6dbd71e" refkind="member"><highlight class="normal">master_doc<sp/>=<sp/></highlight><highlight class="stringliteral">'index'</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="38"><highlight class="normal"></highlight></codeline> -<codeline lineno="39"><highlight class="normal"></highlight><highlight class="comment">#<sp/>General<sp/>information<sp/>about<sp/>the<sp/>project.</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="40" refid="namespaceconf_1aa2c6aefbed1597a70cfb45a760e5977c" refkind="member"><highlight class="normal">project<sp/>=<sp/></highlight><highlight class="stringliteral">u'cmd2'</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="41" refid="namespaceconf_1ac8ccf456b321bc9052c0691a173b6925" refkind="member"><highlight class="normal">copyright<sp/>=<sp/></highlight><highlight class="stringliteral">u'2010,<sp/>Catherine<sp/>Devlin'</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="42"><highlight class="normal"></highlight></codeline> -<codeline lineno="43"><highlight class="normal"></highlight><highlight class="comment">#<sp/>The<sp/>version<sp/>info<sp/>for<sp/>the<sp/>project<sp/>you're<sp/>documenting,<sp/>acts<sp/>as<sp/>replacement<sp/>for</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="44"><highlight class="normal"></highlight><highlight class="comment">#<sp/>|version|<sp/>and<sp/>|release|,<sp/>also<sp/>used<sp/>in<sp/>various<sp/>other<sp/>places<sp/>throughout<sp/>the</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="45"><highlight class="normal"></highlight><highlight class="comment">#<sp/>built<sp/>documents.</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="46"><highlight class="normal"></highlight><highlight class="comment">#</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="47"><highlight class="normal"></highlight><highlight class="comment">#<sp/>The<sp/>short<sp/>X.Y<sp/>version.</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="48" refid="namespaceconf_1a93370314d5e59e93dabf67ca4906c634" refkind="member"><highlight class="normal">version<sp/>=<sp/></highlight><highlight class="stringliteral">'0.6.0'</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="49"><highlight class="normal"></highlight><highlight class="comment">#<sp/>The<sp/>full<sp/>version,<sp/>including<sp/>alpha/beta/rc<sp/>tags.</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="50" refid="namespaceconf_1a90a599726178800ad5a42f6bc2cd5208" refkind="member"><highlight class="normal">release<sp/>=<sp/></highlight><highlight class="stringliteral">'0.6.0'</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="51"><highlight class="normal"></highlight></codeline> -<codeline lineno="52"><highlight class="normal"></highlight><highlight class="comment">#<sp/>The<sp/>language<sp/>for<sp/>content<sp/>autogenerated<sp/>by<sp/>Sphinx.<sp/>Refer<sp/>to<sp/>documentation</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="53"><highlight class="normal"></highlight><highlight class="comment">#<sp/>for<sp/>a<sp/>list<sp/>of<sp/>supported<sp/>languages.</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="54"><highlight class="normal"></highlight><highlight class="comment">#language<sp/>=<sp/>None</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="55"><highlight class="normal"></highlight></codeline> -<codeline lineno="56"><highlight class="normal"></highlight><highlight class="comment">#<sp/>There<sp/>are<sp/>two<sp/>options<sp/>for<sp/>replacing<sp/>|today|:<sp/>either,<sp/>you<sp/>set<sp/>today<sp/>to<sp/>some</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="57"><highlight class="normal"></highlight><highlight class="comment">#<sp/>non-false<sp/>value,<sp/>then<sp/>it<sp/>is<sp/>used:</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="58"><highlight class="normal"></highlight><highlight class="comment">#today<sp/>=<sp/>''</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="59"><highlight class="normal"></highlight><highlight class="comment">#<sp/>Else,<sp/>today_fmt<sp/>is<sp/>used<sp/>as<sp/>the<sp/>format<sp/>for<sp/>a<sp/>strftime<sp/>call.</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="60"><highlight class="normal"></highlight><highlight class="comment">#today_fmt<sp/>=<sp/>'%B<sp/>%d,<sp/>%Y'</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="61"><highlight class="normal"></highlight></codeline> -<codeline lineno="62"><highlight class="normal"></highlight><highlight class="comment">#<sp/>List<sp/>of<sp/>documents<sp/>that<sp/>shouldn't<sp/>be<sp/>included<sp/>in<sp/>the<sp/>build.</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="63"><highlight class="normal"></highlight><highlight class="comment">#unused_docs<sp/>=<sp/>[]</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="64"><highlight class="normal"></highlight></codeline> -<codeline lineno="65"><highlight class="normal"></highlight><highlight class="comment">#<sp/>List<sp/>of<sp/>directories,<sp/>relative<sp/>to<sp/>source<sp/>directory,<sp/>that<sp/>shouldn't<sp/>be<sp/>searched</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="66"><highlight class="normal"></highlight><highlight class="comment">#<sp/>for<sp/>source<sp/>files.</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="67" refid="namespaceconf_1acfb345e27f5356b8778ab7b673e72556" refkind="member"><highlight class="normal">exclude_trees<sp/>=<sp/>[</highlight><highlight class="stringliteral">'_build'</highlight><highlight class="normal">]</highlight></codeline> -<codeline lineno="68"><highlight class="normal"></highlight></codeline> -<codeline lineno="69"><highlight class="normal"></highlight><highlight class="comment">#<sp/>The<sp/>reST<sp/>default<sp/>role<sp/>(used<sp/>for<sp/>this<sp/>markup:<sp/>`text`)<sp/>to<sp/>use<sp/>for<sp/>all<sp/>documents.</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="70"><highlight class="normal"></highlight><highlight class="comment">#default_role<sp/>=<sp/>None</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="71"><highlight class="normal"></highlight></codeline> -<codeline lineno="72"><highlight class="normal"></highlight><highlight class="comment">#<sp/>If<sp/>true,<sp/>'()'<sp/>will<sp/>be<sp/>appended<sp/>to<sp/>:func:<sp/>etc.<sp/>cross-reference<sp/>text.</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="73"><highlight class="normal"></highlight><highlight class="comment">#add_function_parentheses<sp/>=<sp/>True</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="74"><highlight class="normal"></highlight></codeline> -<codeline lineno="75"><highlight class="normal"></highlight><highlight class="comment">#<sp/>If<sp/>true,<sp/>the<sp/>current<sp/>module<sp/>name<sp/>will<sp/>be<sp/>prepended<sp/>to<sp/>all<sp/>description</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="76"><highlight class="normal"></highlight><highlight class="comment">#<sp/>unit<sp/>titles<sp/>(such<sp/>as<sp/>..<sp/>function::).</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="77"><highlight class="normal"></highlight><highlight class="comment">#add_module_names<sp/>=<sp/>True</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="78"><highlight class="normal"></highlight></codeline> -<codeline lineno="79"><highlight class="normal"></highlight><highlight class="comment">#<sp/>If<sp/>true,<sp/>sectionauthor<sp/>and<sp/>moduleauthor<sp/>directives<sp/>will<sp/>be<sp/>shown<sp/>in<sp/>the</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="80"><highlight class="normal"></highlight><highlight class="comment">#<sp/>output.<sp/>They<sp/>are<sp/>ignored<sp/>by<sp/>default.</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="81"><highlight class="normal"></highlight><highlight class="comment">#show_authors<sp/>=<sp/>False</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="82"><highlight class="normal"></highlight></codeline> -<codeline lineno="83"><highlight class="normal"></highlight><highlight class="comment">#<sp/>The<sp/>name<sp/>of<sp/>the<sp/>Pygments<sp/>(syntax<sp/>highlighting)<sp/>style<sp/>to<sp/>use.</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="84" refid="namespaceconf_1afa4e4ed164119ef5f4656e9554ed1f1b" refkind="member"><highlight class="normal">pygments_style<sp/>=<sp/></highlight><highlight class="stringliteral">'sphinx'</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="85"><highlight class="normal"></highlight></codeline> -<codeline lineno="86"><highlight class="normal"></highlight><highlight class="comment">#<sp/>A<sp/>list<sp/>of<sp/>ignored<sp/>prefixes<sp/>for<sp/>module<sp/>index<sp/>sorting.</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="87"><highlight class="normal"></highlight><highlight class="comment">#modindex_common_prefix<sp/>=<sp/>[]</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="88"><highlight class="normal"></highlight></codeline> -<codeline lineno="89"><highlight class="normal"></highlight></codeline> -<codeline lineno="90"><highlight class="normal"></highlight><highlight class="comment">#<sp/>--<sp/>Options<sp/>for<sp/>HTML<sp/>output<sp/>---------------------------------------------------</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="91"><highlight class="normal"></highlight></codeline> -<codeline lineno="92"><highlight class="normal"></highlight><highlight class="comment">#<sp/>The<sp/>theme<sp/>to<sp/>use<sp/>for<sp/>HTML<sp/>and<sp/>HTML<sp/>Help<sp/>pages.<sp/><sp/>Major<sp/>themes<sp/>that<sp/>come<sp/>with</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="93"><highlight class="normal"></highlight><highlight class="comment">#<sp/>Sphinx<sp/>are<sp/>currently<sp/>'default'<sp/>and<sp/>'sphinxdoc'.</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="94" refid="namespaceconf_1a7f1b143ff25817758abd21a7db110510" refkind="member"><highlight class="normal">html_theme<sp/>=<sp/></highlight><highlight class="stringliteral">'default'</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="95"><highlight class="normal"></highlight></codeline> -<codeline lineno="96"><highlight class="normal"></highlight><highlight class="comment">#<sp/>Theme<sp/>options<sp/>are<sp/>theme-specific<sp/>and<sp/>customize<sp/>the<sp/>look<sp/>and<sp/>feel<sp/>of<sp/>a<sp/>theme</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="97"><highlight class="normal"></highlight><highlight class="comment">#<sp/>further.<sp/><sp/>For<sp/>a<sp/>list<sp/>of<sp/>options<sp/>available<sp/>for<sp/>each<sp/>theme,<sp/>see<sp/>the</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="98"><highlight class="normal"></highlight><highlight class="comment">#<sp/>documentation.</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="99"><highlight class="normal"></highlight><highlight class="comment">#html_theme_options<sp/>=<sp/>{}</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="100"><highlight class="normal"></highlight></codeline> -<codeline lineno="101"><highlight class="normal"></highlight><highlight class="comment">#<sp/>Add<sp/>any<sp/>paths<sp/>that<sp/>contain<sp/>custom<sp/>themes<sp/>here,<sp/>relative<sp/>to<sp/>this<sp/>directory.</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="102"><highlight class="normal"></highlight><highlight class="comment">#html_theme_path<sp/>=<sp/>[]</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="103"><highlight class="normal"></highlight></codeline> -<codeline lineno="104"><highlight class="normal"></highlight><highlight class="comment">#<sp/>The<sp/>name<sp/>for<sp/>this<sp/>set<sp/>of<sp/>Sphinx<sp/>documents.<sp/><sp/>If<sp/>None,<sp/>it<sp/>defaults<sp/>to</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="105"><highlight class="normal"></highlight><highlight class="comment">#<sp/>"<project><sp/>v<release><sp/>documentation".</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="106"><highlight class="normal"></highlight><highlight class="comment">#html_title<sp/>=<sp/>None</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="107"><highlight class="normal"></highlight></codeline> -<codeline lineno="108"><highlight class="normal"></highlight><highlight class="comment">#<sp/>A<sp/>shorter<sp/>title<sp/>for<sp/>the<sp/>navigation<sp/>bar.<sp/><sp/>Default<sp/>is<sp/>the<sp/>same<sp/>as<sp/>html_title.</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="109"><highlight class="normal"></highlight><highlight class="comment">#html_short_title<sp/>=<sp/>None</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="110"><highlight class="normal"></highlight></codeline> -<codeline lineno="111"><highlight class="normal"></highlight><highlight class="comment">#<sp/>The<sp/>name<sp/>of<sp/>an<sp/>image<sp/>file<sp/>(relative<sp/>to<sp/>this<sp/>directory)<sp/>to<sp/>place<sp/>at<sp/>the<sp/>top</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="112"><highlight class="normal"></highlight><highlight class="comment">#<sp/>of<sp/>the<sp/>sidebar.</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="113"><highlight class="normal"></highlight><highlight class="comment">#html_logo<sp/>=<sp/>None</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="114"><highlight class="normal"></highlight></codeline> -<codeline lineno="115"><highlight class="normal"></highlight><highlight class="comment">#<sp/>The<sp/>name<sp/>of<sp/>an<sp/>image<sp/>file<sp/>(within<sp/>the<sp/>static<sp/>path)<sp/>to<sp/>use<sp/>as<sp/>favicon<sp/>of<sp/>the</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="116"><highlight class="normal"></highlight><highlight class="comment">#<sp/>docs.<sp/><sp/>This<sp/>file<sp/>should<sp/>be<sp/>a<sp/>Windows<sp/>icon<sp/>file<sp/>(.ico)<sp/>being<sp/>16x16<sp/>or<sp/>32x32</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="117"><highlight class="normal"></highlight><highlight class="comment">#<sp/>pixels<sp/>large.</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="118"><highlight class="normal"></highlight><highlight class="comment">#html_favicon<sp/>=<sp/>None</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="119"><highlight class="normal"></highlight></codeline> -<codeline lineno="120"><highlight class="normal"></highlight><highlight class="comment">#<sp/>Add<sp/>any<sp/>paths<sp/>that<sp/>contain<sp/>custom<sp/>static<sp/>files<sp/>(such<sp/>as<sp/>style<sp/>sheets)<sp/>here,</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="121"><highlight class="normal"></highlight><highlight class="comment">#<sp/>relative<sp/>to<sp/>this<sp/>directory.<sp/>They<sp/>are<sp/>copied<sp/>after<sp/>the<sp/>builtin<sp/>static<sp/>files,</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="122"><highlight class="normal"></highlight><highlight class="comment">#<sp/>so<sp/>a<sp/>file<sp/>named<sp/>"default.css"<sp/>will<sp/>overwrite<sp/>the<sp/>builtin<sp/>"default.css".</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="123" refid="namespaceconf_1acb91fefcfd3aa6f3529fa682ab834832" refkind="member"><highlight class="normal">html_static_path<sp/>=<sp/>[</highlight><highlight class="stringliteral">'_static'</highlight><highlight class="normal">]</highlight></codeline> -<codeline lineno="124"><highlight class="normal"></highlight></codeline> -<codeline lineno="125"><highlight class="normal"></highlight><highlight class="comment">#<sp/>If<sp/>not<sp/>'',<sp/>a<sp/>'Last<sp/>updated<sp/>on:'<sp/>timestamp<sp/>is<sp/>inserted<sp/>at<sp/>every<sp/>page<sp/>bottom,</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="126"><highlight class="normal"></highlight><highlight class="comment">#<sp/>using<sp/>the<sp/>given<sp/>strftime<sp/>format.</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="127"><highlight class="normal"></highlight><highlight class="comment">#html_last_updated_fmt<sp/>=<sp/>'%b<sp/>%d,<sp/>%Y'</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="128"><highlight class="normal"></highlight></codeline> -<codeline lineno="129"><highlight class="normal"></highlight><highlight class="comment">#<sp/>If<sp/>true,<sp/>SmartyPants<sp/>will<sp/>be<sp/>used<sp/>to<sp/>convert<sp/>quotes<sp/>and<sp/>dashes<sp/>to</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="130"><highlight class="normal"></highlight><highlight class="comment">#<sp/>typographically<sp/>correct<sp/>entities.</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="131"><highlight class="normal"></highlight><highlight class="comment">#html_use_smartypants<sp/>=<sp/>True</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="132"><highlight class="normal"></highlight></codeline> -<codeline lineno="133"><highlight class="normal"></highlight><highlight class="comment">#<sp/>Custom<sp/>sidebar<sp/>templates,<sp/>maps<sp/>document<sp/>names<sp/>to<sp/>template<sp/>names.</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="134"><highlight class="normal"></highlight><highlight class="comment">#html_sidebars<sp/>=<sp/>{}</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="135"><highlight class="normal"></highlight></codeline> -<codeline lineno="136"><highlight class="normal"></highlight><highlight class="comment">#<sp/>Additional<sp/>templates<sp/>that<sp/>should<sp/>be<sp/>rendered<sp/>to<sp/>pages,<sp/>maps<sp/>page<sp/>names<sp/>to</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="137"><highlight class="normal"></highlight><highlight class="comment">#<sp/>template<sp/>names.</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="138"><highlight class="normal"></highlight><highlight class="comment">#html_additional_pages<sp/>=<sp/>{}</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="139"><highlight class="normal"></highlight></codeline> -<codeline lineno="140"><highlight class="normal"></highlight><highlight class="comment">#<sp/>If<sp/>false,<sp/>no<sp/>module<sp/>index<sp/>is<sp/>generated.</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="141"><highlight class="normal"></highlight><highlight class="comment">#html_use_modindex<sp/>=<sp/>True</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="142"><highlight class="normal"></highlight></codeline> -<codeline lineno="143"><highlight class="normal"></highlight><highlight class="comment">#<sp/>If<sp/>false,<sp/>no<sp/>index<sp/>is<sp/>generated.</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="144"><highlight class="normal"></highlight><highlight class="comment">#html_use_index<sp/>=<sp/>True</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="145"><highlight class="normal"></highlight></codeline> -<codeline lineno="146"><highlight class="normal"></highlight><highlight class="comment">#<sp/>If<sp/>true,<sp/>the<sp/>index<sp/>is<sp/>split<sp/>into<sp/>individual<sp/>pages<sp/>for<sp/>each<sp/>letter.</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="147"><highlight class="normal"></highlight><highlight class="comment">#html_split_index<sp/>=<sp/>False</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="148"><highlight class="normal"></highlight></codeline> -<codeline lineno="149"><highlight class="normal"></highlight><highlight class="comment">#<sp/>If<sp/>true,<sp/>links<sp/>to<sp/>the<sp/>reST<sp/>sources<sp/>are<sp/>added<sp/>to<sp/>the<sp/>pages.</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="150"><highlight class="normal"></highlight><highlight class="comment">#html_show_sourcelink<sp/>=<sp/>True</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="151"><highlight class="normal"></highlight></codeline> -<codeline lineno="152"><highlight class="normal"></highlight><highlight class="comment">#<sp/>If<sp/>true,<sp/>an<sp/>OpenSearch<sp/>description<sp/>file<sp/>will<sp/>be<sp/>output,<sp/>and<sp/>all<sp/>pages<sp/>will</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="153"><highlight class="normal"></highlight><highlight class="comment">#<sp/>contain<sp/>a<sp/><link><sp/>tag<sp/>referring<sp/>to<sp/>it.<sp/><sp/>The<sp/>value<sp/>of<sp/>this<sp/>option<sp/>must<sp/>be<sp/>the</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="154"><highlight class="normal"></highlight><highlight class="comment">#<sp/>base<sp/>URL<sp/>from<sp/>which<sp/>the<sp/>finished<sp/>HTML<sp/>is<sp/>served.</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="155"><highlight class="normal"></highlight><highlight class="comment">#html_use_opensearch<sp/>=<sp/>''</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="156"><highlight class="normal"></highlight></codeline> -<codeline lineno="157"><highlight class="normal"></highlight><highlight class="comment">#<sp/>If<sp/>nonempty,<sp/>this<sp/>is<sp/>the<sp/>file<sp/>name<sp/>suffix<sp/>for<sp/>HTML<sp/>files<sp/>(e.g.<sp/>".xhtml").</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="158"><highlight class="normal"></highlight><highlight class="comment">#html_file_suffix<sp/>=<sp/>''</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="159"><highlight class="normal"></highlight></codeline> -<codeline lineno="160"><highlight class="normal"></highlight><highlight class="comment">#<sp/>Output<sp/>file<sp/>base<sp/>name<sp/>for<sp/>HTML<sp/>help<sp/>builder.</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="161" refid="namespaceconf_1a74d707b34bba474e9057f383ad01de83" refkind="member"><highlight class="normal">htmlhelp_basename<sp/>=<sp/></highlight><highlight class="stringliteral">'cmd2doc'</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="162"><highlight class="normal"></highlight></codeline> -<codeline lineno="163"><highlight class="normal"></highlight></codeline> -<codeline lineno="164"><highlight class="normal"></highlight><highlight class="comment">#<sp/>--<sp/>Options<sp/>for<sp/>LaTeX<sp/>output<sp/>--------------------------------------------------</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="165"><highlight class="normal"></highlight></codeline> -<codeline lineno="166"><highlight class="normal"></highlight><highlight class="comment">#<sp/>The<sp/>paper<sp/>size<sp/>('letter'<sp/>or<sp/>'a4').</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="167"><highlight class="normal"></highlight><highlight class="comment">#latex_paper_size<sp/>=<sp/>'letter'</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="168"><highlight class="normal"></highlight></codeline> -<codeline lineno="169"><highlight class="normal"></highlight><highlight class="comment">#<sp/>The<sp/>font<sp/>size<sp/>('10pt',<sp/>'11pt'<sp/>or<sp/>'12pt').</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="170"><highlight class="normal"></highlight><highlight class="comment">#latex_font_size<sp/>=<sp/>'10pt'</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="171"><highlight class="normal"></highlight></codeline> -<codeline lineno="172"><highlight class="normal"></highlight><highlight class="comment">#<sp/>Grouping<sp/>the<sp/>document<sp/>tree<sp/>into<sp/>LaTeX<sp/>files.<sp/>List<sp/>of<sp/>tuples</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="173"><highlight class="normal"></highlight><highlight class="comment">#<sp/>(source<sp/>start<sp/>file,<sp/>target<sp/>name,<sp/>title,<sp/>author,<sp/>documentclass<sp/>[howto/manual]).</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="174" refid="namespaceconf_1a00b7896473527f894006130b1113cb4b" refkind="member"><highlight class="normal">latex_documents<sp/>=<sp/>[</highlight></codeline> -<codeline lineno="175"><highlight class="normal"><sp/><sp/>(</highlight><highlight class="stringliteral">'index'</highlight><highlight class="normal">,<sp/></highlight><highlight class="stringliteral">'cmd2.tex'</highlight><highlight class="normal">,<sp/></highlight><highlight class="stringliteral">u'cmd2<sp/>Documentation'</highlight><highlight class="normal">,</highlight></codeline> -<codeline lineno="176"><highlight class="normal"><sp/><sp/><sp/></highlight><highlight class="stringliteral">u'Catherine<sp/>Devlin'</highlight><highlight class="normal">,<sp/></highlight><highlight class="stringliteral">'manual'</highlight><highlight class="normal">),</highlight></codeline> -<codeline lineno="177"><highlight class="normal">]</highlight></codeline> -<codeline lineno="178"><highlight class="normal"></highlight></codeline> -<codeline lineno="179"><highlight class="normal"></highlight><highlight class="comment">#<sp/>The<sp/>name<sp/>of<sp/>an<sp/>image<sp/>file<sp/>(relative<sp/>to<sp/>this<sp/>directory)<sp/>to<sp/>place<sp/>at<sp/>the<sp/>top<sp/>of</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="180"><highlight class="normal"></highlight><highlight class="comment">#<sp/>the<sp/>title<sp/>page.</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="181"><highlight class="normal"></highlight><highlight class="comment">#latex_logo<sp/>=<sp/>None</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="182"><highlight class="normal"></highlight></codeline> -<codeline lineno="183"><highlight class="normal"></highlight><highlight class="comment">#<sp/>For<sp/>"manual"<sp/>documents,<sp/>if<sp/>this<sp/>is<sp/>true,<sp/>then<sp/>toplevel<sp/>headings<sp/>are<sp/>parts,</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="184"><highlight class="normal"></highlight><highlight class="comment">#<sp/>not<sp/>chapters.</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="185"><highlight class="normal"></highlight><highlight class="comment">#latex_use_parts<sp/>=<sp/>False</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="186"><highlight class="normal"></highlight></codeline> -<codeline lineno="187"><highlight class="normal"></highlight><highlight class="comment">#<sp/>Additional<sp/>stuff<sp/>for<sp/>the<sp/>LaTeX<sp/>preamble.</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="188"><highlight class="normal"></highlight><highlight class="comment">#latex_preamble<sp/>=<sp/>''</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="189"><highlight class="normal"></highlight></codeline> -<codeline lineno="190"><highlight class="normal"></highlight><highlight class="comment">#<sp/>Documents<sp/>to<sp/>append<sp/>as<sp/>an<sp/>appendix<sp/>to<sp/>all<sp/>manuals.</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="191"><highlight class="normal"></highlight><highlight class="comment">#latex_appendices<sp/>=<sp/>[]</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="192"><highlight class="normal"></highlight></codeline> -<codeline lineno="193"><highlight class="normal"></highlight><highlight class="comment">#<sp/>If<sp/>false,<sp/>no<sp/>module<sp/>index<sp/>is<sp/>generated.</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="194"><highlight class="normal"></highlight><highlight class="comment">#latex_use_modindex<sp/>=<sp/>True</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="195"><highlight class="normal"></highlight></codeline> -<codeline lineno="196"><highlight class="normal"></highlight></codeline> -<codeline lineno="197"><highlight class="normal"></highlight><highlight class="comment">#<sp/>Example<sp/>configuration<sp/>for<sp/>intersphinx:<sp/>refer<sp/>to<sp/>the<sp/>Python<sp/>standard<sp/>library.</highlight><highlight class="normal"></highlight></codeline> -<codeline lineno="198" refid="namespaceconf_1a9d1981d8fc4e2521d62ffc607e3ef8f2" refkind="member"><highlight class="normal">intersphinx_mapping<sp/>=<sp/>{</highlight><highlight class="stringliteral">'http://docs.python.org/'</highlight><highlight class="normal">:<sp/></highlight><highlight class="keywordtype">None</highlight><highlight class="normal">}</highlight></codeline> - </programlisting> - <location file="/Users/amrogers/Developer/Projects/cmd2/docs/conf.py"/> - </compounddef> -</doxygen> |