1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
|
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
<html> <head>
<title>Epydoc</title>
<link rel="stylesheet" href="epydoc.css" type="text/css"/>
</head>
<!-- $Id: index.html,v 1.14 2003/07/22 05:18:25 edloper Exp $ -->
<body>
<h1>Epydoc</h1>
<p> Epydoc is a tool for generating API documentation for Python
modules, based on their docstrings. For an example of epydoc's
output, see the API documentation for epydoc itself (<a
href="api/">html</a>, <a href="epydoc.pdf">pdf</a>). A lightweight
markup language called <a href="epytext.html">epytext</a> can be used
to format docstrings, and to add information about specific fields,
such as parameters and instance variables. Epydoc also understands
docstrings written in ReStructuredText, Javadoc, and plaintext. </p>
<table class="transparent" width="100%">
<tr valign="top"><td width="50%"><ul>
<li> <a href="installing.html">Installing Epydoc</a> </li>
<li> <a href="using.html">Using Epydoc</a> </li>
<li> <a href="epytextintro.html">A Brief Introduction to
Epytext</a> </li>
<li> <a href="epytext.html">The Epytext Markup Language Manual</a> </li>
<li> <a href="othermarkup.html">ReStructuredText and Javadoc</a> </li>
<li> <a href="fields.html">Epydoc Fields</a> </li>
</ul></td><td><ul>
<li> <a href="docstrings.html">Python Docstrings</a> </li>
<li> <a href="api/">API Documentation</a> </li>
<li> <a href="relatedprojects.html">Related Projects</a> </li>
<li> <a href="history.html">History</a> </li>
<li> <a href="future.html">Future Directions</a> </li>
<li> <a href="license.html">Open Source License</a> </li>
</ul></tr></table>
<p> The latest release of epydoc (version 2.0) can be
downloaded from the <a
href="http://sourceforge.net/project/showfiles.php?group_id=32455">SourceForge
download page</a>. See <a href="installing.html">Installing
Epydoc</a> for more information. </p>
<p> For a more extensive example of epydoc's output, see the API
documentation for <a
href="http://epydoc.sourceforge.net/stdlib/">Python 2.2</a>. </p>
<table width="100%" class="navbox" cellpadding="1" cellspacing="0">
<tr>
<!-- <td align="center" width="20%">
<a class="nav" href="index.html">[Epydoc]</a></td> -->
<td align="center" width="20%">
<a class="nav" href="installing.html">[Installing]</a></td>
<td align="center" width="20%">
<a class="nav" href="using.html">[Using]</a></td>
<td align="center" width="20%">
<a class="nav" href="epytext.html">[Epytext]</a></td>
<td align="center" width="20%">
<a class="nav" href="http://www.cis.upenn.edu/~edloper/">[Author]</a></td>
<td align="center" width="20%">
<A href="http://sourceforge.net/projects/epydoc">
<IMG src="http://sourceforge.net/sflogo.php?group_id=32455&type=1"
width="88" height="26" border="0" alt="SourceForge"
align="top"/></A></td>
</tr>
</table>
<font size="-1">
<!-- hhmts start --> Last modified: Tue Jul 22 05:15:58 XXX 2003 <!-- hhmts end -->
</font>
</body>
</html>
|
