3
3
<title>Epydoc: Future Directions</title>
4
4
<link rel="stylesheet" href="epydoc.css" type="text/css"/>
6
<!-- $Id: future.html,v 1.3 2002/10/02 07:07:09 edloper Exp $ -->
6
<!-- $Id: future.html 1211 2006-04-10 19:38:37Z edloper $ -->
9
10
<h1> Epydoc: Future Directions </h1>
11
<p> I don't expect epydoc to undergo any major changes in the near
12
future. In particular, I am unlikely to add any new block structure
13
constructs (such as tables) to the epytext markup language; it is
14
currently quite simple and clean, and I'd like to keep it that way.
15
However, if there are improvements to the epytext markup language that
16
you feel would not significantly affect its simplicity, let me know.
17
And if there are any improvements you'd like made to epydoc tool
18
itself, feel free to <a
19
href="mailto:edloper@gradient.cis.upenn.edu">email me</a>. </p>
22
href="http://docutils.sourceforge.net/">Docutils</a> becomes the
23
standard framework for Python API Documentation systems, I will look
24
into integrating epydoc into Docutils. </p>
28
<p> These are changes I'd like to make, if and when I get the time.
29
The order that they're listed in roughly reflects the order that I
30
would do them, if I got time. </p>
33
<li> Package and release version 1.0. </li>
34
<li> Add special escape sequences, such as "<code>{->}</code>". </li>
35
<li> Change the parsing algorithm used by fields to eliminate the
36
restriction that the blocks contained by a field have indentation
37
greater than the indentation of the field tag; and the
38
recommendation that field lists be separated from paragraphs by a
40
<li> Add LaTeX or docbook output. </li>
13
<p> Epydoc version 3.0 is currently in alpha release. My current
14
plans for the near future include: </p>
17
<li> Improve support for graph generation. </li>
18
<li> Work on plaintext output. </li>
20
<li> More regression tests </li>
21
<li> Add support for generating indices of bugs, todo items,
23
<li> Add an <code>@ingroup</code> tag.
24
<li> Release epydoc 3.0. </li>
28
<p> Things I'd eventually like to see in epydoc include: </p>
31
<li> Change the epytext parser to use simple classes instead
33
<li> Output to man (troff)? </li>
34
<li> Output to docbook or directly to pdf? </li>
43
38
<table width="100%" class="navbox" cellpadding="1" cellspacing="0">
45
<td align="center" width="16.6%">
46
<a class="nav" href="index.html">[Epydoc]</a></td>
47
<td align="center" width="16.6%">
48
<a class="nav" href="installing.html">[Installing]</a></td>
49
<td align="center" width="16.6%">
50
<a class="nav" href="using.html">[Using]</a></td>
51
<td align="center" width="16.6%">
52
<a class="nav" href="epytext.html">[Epytext]</a></td>
53
<td align="center" width="16.6%">
54
<a class="nav" href="http://www.cis.upenn.edu/~edloper/">[Author]</a></td>
55
<td align="center" width="16.6%">
40
<a class="nav" href="index.html">
41
<td align="center" width="20%" class="nav">
42
<a class="nav" href="index.html">
44
<a class="nav" href="installing.html">
45
<td align="center" width="20%" class="nav">
46
<a class="nav" href="installing.html">
47
Installing Epydoc</a></td></a>
48
<a class="nav" href="using.html">
49
<td align="center" width="20%" class="nav">
50
<a class="nav" href="using.html">
51
Using Epydoc</a></td></a>
52
<a class="nav" href="epytext.html">
53
<td align="center" width="20%" class="nav">
54
<a class="nav" href="epytext.html">
56
<td align="center" width="20%" class="nav">
56
58
<A href="http://sourceforge.net/projects/epydoc">
57
<IMG src="http://sourceforge.net/sflogo.php?group_id=32455&type=1"
58
60
width="88" height="26" border="0" alt="SourceForge"
59
61
align="top"/></A></td>
64
<!-- hhmts start --> Last modified: Wed Sep 25 03:43:59 EDT 2002 <!-- hhmts end -->