<!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.coverage – Collect doc coverage stats — Sphinx 1.1.3 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.1.3', 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 1.1.3 documentation" href="../_static/opensearch.xml"/> <link rel="top" title="Sphinx 1.1.3 documentation" href="../index.html" /> <link rel="up" title="Sphinx Extensions" href="../extensions.html" /> <link rel="next" title="sphinx.ext.todo – Support for todo items" href="todo.html" /> <link rel="prev" title="sphinx.ext.ifconfig – Include content based on configuration" href="ifconfig.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="todo.html" title="sphinx.ext.todo – Support for todo items" accesskey="N">next</a> |</li> <li class="right" > <a href="ifconfig.html" title="sphinx.ext.ifconfig – Include content based on configuration" 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="ifconfig.html" title="previous chapter"><tt class="docutils literal"><span class="pre">sphinx.ext.ifconfig</span></tt> – Include content based on configuration</a></p> <h4>Next topic</h4> <p class="topless"><a href="todo.html" title="next chapter"><tt class="docutils literal"><span class="pre">sphinx.ext.todo</span></tt> – Support for todo items</a></p> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../_sources/ext/coverage.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" /> <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.coverage"> <span id="sphinx-ext-coverage-collect-doc-coverage-stats"></span><h1><a class="reference internal" href="#module-sphinx.ext.coverage" title="sphinx.ext.coverage: Check Python modules and C API for coverage in the documentation."><tt class="xref py py-mod docutils literal"><span class="pre">sphinx.ext.coverage</span></tt></a> – Collect doc coverage stats<a class="headerlink" href="#module-sphinx.ext.coverage" title="Permalink to this headline">¶</a></h1> <p>This extension features one additional builder, the <a class="reference internal" href="#sphinx.ext.coverage.CoverageBuilder" title="sphinx.ext.coverage.CoverageBuilder"><tt class="xref py py-class docutils literal"><span class="pre">CoverageBuilder</span></tt></a>.</p> <dl class="class"> <dt id="sphinx.ext.coverage.CoverageBuilder"> <em class="property">class </em><tt class="descclassname">sphinx.ext.coverage.</tt><tt class="descname">CoverageBuilder</tt><a class="headerlink" href="#sphinx.ext.coverage.CoverageBuilder" title="Permalink to this definition">¶</a></dt> <dd><p>To use this builder, activate the coverage extension in your configuration file and give <tt class="docutils literal"><span class="pre">-b</span> <span class="pre">coverage</span></tt> on the command line.</p> </dd></dl> <div class="admonition-todo admonition" id="index-0"> <p class="first admonition-title">Todo</p> <p class="last">Write this section.</p> </div> <p>Several new configuration values can be used to specify what the builder should check:</p> <dl class="confval"> <dt id="confval-coverage_ignore_modules"> <tt class="descname">coverage_ignore_modules</tt><a class="headerlink" href="#confval-coverage_ignore_modules" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="confval"> <dt id="confval-coverage_ignore_functions"> <tt class="descname">coverage_ignore_functions</tt><a class="headerlink" href="#confval-coverage_ignore_functions" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="confval"> <dt id="confval-coverage_ignore_classes"> <tt class="descname">coverage_ignore_classes</tt><a class="headerlink" href="#confval-coverage_ignore_classes" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="confval"> <dt id="confval-coverage_c_path"> <tt class="descname">coverage_c_path</tt><a class="headerlink" href="#confval-coverage_c_path" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="confval"> <dt id="confval-coverage_c_regexes"> <tt class="descname">coverage_c_regexes</tt><a class="headerlink" href="#confval-coverage_c_regexes" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="confval"> <dt id="confval-coverage_ignore_c_items"> <tt class="descname">coverage_ignore_c_items</tt><a class="headerlink" href="#confval-coverage_ignore_c_items" title="Permalink to this definition">¶</a></dt> <dd></dd></dl> <dl class="confval"> <dt id="confval-coverage_write_headline"> <tt class="descname">coverage_write_headline</tt><a class="headerlink" href="#confval-coverage_write_headline" title="Permalink to this definition">¶</a></dt> <dd><p>Set to <tt class="docutils literal"><span class="pre">False</span></tt> to not write headlines.</p> <p class="versionadded"> <span class="versionmodified">New in version 1.1.</span></p> </dd></dl> <dl class="confval"> <dt id="confval-coverage_skip_undoc_in_source"> <tt class="descname">coverage_skip_undoc_in_source</tt><a class="headerlink" href="#confval-coverage_skip_undoc_in_source" title="Permalink to this definition">¶</a></dt> <dd><p>Skip objects that are not documented in the source with a docstring. <tt class="docutils literal"><span class="pre">False</span></tt> by default.</p> <p class="versionadded"> <span class="versionmodified">New in version 1.1.</span></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="todo.html" title="sphinx.ext.todo – Support for todo items" >next</a> |</li> <li class="right" > <a href="ifconfig.html" title="sphinx.ext.ifconfig – Include content based on configuration" >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.1.3. </div> </body> </html>