<!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/html; charset=utf-8" />
<title>sphinx.ext.todo – Support for todo items — Sphinx v1.0.7 documentation</title>
<link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.0.7',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Sphinx v1.0.7 documentation"
href="../_static/opensearch.xml"/>
<link rel="top" title="Sphinx v1.0.7 documentation" href="../index.html" />
<link rel="up" title="Sphinx Extensions" href="../extensions.html" />
<link rel="next" title="sphinx.ext.extlinks – Markup to shorten external links" href="extlinks.html" />
<link rel="prev" title="sphinx.ext.coverage – Collect doc coverage stats" href="coverage.html" />
<style type="text/css">
table.right { float: right; margin-left: 20px; }
table.right td { border: 1px solid #ccc; }
</style>
</head>
<body>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
<img src="../_static/sphinx.png" alt="Sphinx logo" />
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="extlinks.html" title="sphinx.ext.extlinks – Markup to shorten external links"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="coverage.html" title="sphinx.ext.coverage – Collect doc coverage stats"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">Sphinx home</a> | </li>
<li><a href="../contents.html">Documentation</a>
»</li>
<li><a href="../extensions.html" accesskey="U">Sphinx Extensions</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="coverage.html"
title="previous chapter"><tt class="docutils literal docutils literal docutils literal"><span class="pre">sphinx.ext.coverage</span></tt> – Collect doc coverage stats</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="extlinks.html"
title="next chapter"><tt class="docutils literal docutils literal"><span class="pre">sphinx.ext.extlinks</span></tt> – Markup to shorten external links</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/ext/todo.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-sphinx.ext.todo">
<span id="sphinx-ext-todo-support-for-todo-items"></span><h1><a class="reference internal" href="#module-sphinx.ext.todo" title="sphinx.ext.todo: Allow inserting todo items into documents."><tt class="xref py py-mod docutils literal"><span class="pre">sphinx.ext.todo</span></tt></a> – Support for todo items<a class="headerlink" href="#module-sphinx.ext.todo" title="Permalink to this headline">¶</a></h1>
<p><em>Module author: Daniel Bültmann</em></p>
<p class="versionadded">
<span class="versionmodified">New in version 0.5.</span></p>
<p>There are two additional directives when using this extension:</p>
<dl class="directive">
<dt id="directive-todo">
<tt class="descname">.. todo::</tt><a class="headerlink" href="#directive-todo" title="Permalink to this definition">¶</a></dt>
<dd><p>Use this directive like, for example, <a class="reference internal" href="../markup/para.html#directive-note" title="note directive"><tt class="xref rst rst-dir docutils literal"><span class="pre">note</span></tt></a>.</p>
<p>It will only show up in the output if <a class="reference internal" href="#confval-todo_include_todos"><tt class="xref std std-confval docutils literal"><span class="pre">todo_include_todos</span></tt></a> is true.</p>
</dd></dl>
<dl class="directive">
<dt id="directive-todolist">
<tt class="descname">.. todolist::</tt><a class="headerlink" href="#directive-todolist" title="Permalink to this definition">¶</a></dt>
<dd><p>This directive is replaced by a list of all todo directives in the whole
documentation, if <a class="reference internal" href="#confval-todo_include_todos"><tt class="xref std std-confval docutils literal"><span class="pre">todo_include_todos</span></tt></a> is true.</p>
</dd></dl>
<p>There is also an additional config value:</p>
<dl class="confval">
<dt id="confval-todo_include_todos">
<tt class="descname">todo_include_todos</tt><a class="headerlink" href="#confval-todo_include_todos" title="Permalink to this definition">¶</a></dt>
<dd><p>If this is <tt class="xref docutils literal"><span class="pre">True</span></tt>, <a class="reference internal" href="#directive-todo" title="todo directive"><tt class="xref rst rst-dir docutils literal"><span class="pre">todo</span></tt></a> and <a class="reference internal" href="#directive-todolist" title="todolist directive"><tt class="xref rst rst-dir docutils literal"><span class="pre">todolist</span></tt></a> produce output, else
they produce nothing. The default is <tt class="xref docutils literal"><span class="pre">False</span></tt>.</p>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="extlinks.html" title="sphinx.ext.extlinks – Markup to shorten external links"
>next</a> |</li>
<li class="right" >
<a href="coverage.html" title="sphinx.ext.coverage – Collect doc coverage stats"
>previous</a> |</li>
<li><a href="../index.html">Sphinx home</a> | </li>
<li><a href="../contents.html">Documentation</a>
»</li>
<li><a href="../extensions.html" >Sphinx Extensions</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2007-2011, Georg Brandl.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
</div>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
2b39e69e45f9a0b2b3aece7339c56216
>
files
>
93
