epydoc 3.0 released

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

epydoc 3.0 released

Edward Loper
Announcing epydoc 3.0
~~~~~~~~~~~~~~~~~~~~~
  Webpage: http://epydoc.sourceforge.net/
  Download: http://tinyurl.com/yoo6d7

About epydoc
~~~~~~~~~~~~
Epydoc is a tool for generating API documentation for Python modules,
based on their docstrings.  A lightweight markup language called
epytext 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.  For some examples of the documentation generated by
epydoc, see:

  - The API documentation for epydoc.
    <http://epydoc.sourceforge.net/api/>

  - The API documentation for the Python 2.5 standard library.
    <http://epydoc.sourceforge.net/stdlib/>

  - The API documentation for NLTK, the natural language toolkit.
    <http://nltk.sourceforge.net/lite/doc/api/>

Improvements in Version 3.0
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Version 3.0 of epydoc adds support for extracting documentation
information using both introspection (i.e., importing & inspecting the
modules programmatically) and parsing (i.e., reading the source code of
the modules); and for combining both sources of information.  This is
important because each source has its own advantages and disadvantages
with respect to the other. See the epydoc FAQ for more information
about the relative benefits of introspection and parsing, and why it's
good to merge information from both sources:

    http://epydoc.sourceforge.net/faq.html#introspect_vs_parse

Version 3.0 also adds the following features:

  * Support for variable docstrings.

  * Automatic generating of source code graphs, including class trees,
    package trees, uml class graphs, and import graphs.

  * Syntax highlighted source code, including links from identifiers
    back into the documentation.

For more details about what's new in Epydoc 3.0, see:

    http://epydoc.sourceforge.net/whatsnew.html

----------------------------------------------------------------------
Edward Loper       [hidden email]
                   http://www.cis.upenn.edu/~edloper/
----------------------------------------------------------------------
_______________________________________________
Doc-SIG maillist  -  [hidden email]
http://mail.python.org/mailman/listinfo/doc-sig