<html lang="en">
<head>
<title>BuildEPYDoc - BuildBot Manual - 0.8.4p1</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="BuildBot Manual - 0.8.4p1">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Python-BuildSteps.html#Python-BuildSteps" title="Python BuildSteps">
<link rel="next" href="PyFlakes.html#PyFlakes" title="PyFlakes">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
This is the BuildBot manual for Buildbot version 0.8.4p1.
Copyright (C) 2005, 2006, 2009, 2010 Brian Warner
Copying and distribution of this file, with or without
modification, are permitted in any medium without royalty
provided the copyright notice and this notice are preserved.-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<div class="node">
<a name="BuildEPYDoc"></a>
<p>
Next: <a rel="next" accesskey="n" href="PyFlakes.html#PyFlakes">PyFlakes</a>,
Up: <a rel="up" accesskey="u" href="Python-BuildSteps.html#Python-BuildSteps">Python BuildSteps</a>
<hr>
</div>
<h5 class="subsubsection">4.12.6.1 BuildEPYDoc</h5>
<p><a name="index-buildbot_002esteps_002epython_002eBuildEPYDoc-116"></a>
<a href="http://epydoc.sourceforge.net/">epydoc</a> is a tool for generating
API documentation for Python modules from their docstrings. It reads
all the .py files from your source tree, processes the docstrings
therein, and creates a large tree of .html files (or a single .pdf
file).
<p>The <code>buildbot.steps.python.BuildEPYDoc</code> step will run
<samp><span class="command">epydoc</span></samp> to produce this API documentation, and will count the
errors and warnings from its output.
<p>You must supply the command line to be used. The default is
<samp><span class="command">make epydocs</span></samp>, which assumes that your project has a Makefile
with an “epydocs” target. You might wish to use something like
<samp><span class="command">epydoc -o apiref source/PKGNAME</span></samp> instead. You might also want
to add <samp><span class="command">--pdf</span></samp> to generate a PDF file instead of a large tree
of HTML files.
<p>The API docs are generated in-place in the build tree (under the
workdir, in the subdirectory controlled by the “-o” argument). To
make them useful, you will probably have to copy them to somewhere
they can be read. A command like <samp><span class="command">rsync -ad apiref/
dev.example.com:~public_html/current-apiref/</span></samp> might be useful. You
might instead want to bundle them into a tarball and publish it in the
same place where the generated install tarball is placed.
<pre class="example"> from buildbot.steps.python import BuildEPYDoc
...
f.addStep(BuildEPYDoc(command=["epydoc", "-o", "apiref", "source/mypkg"]))
</pre>
</body></html>
