Tried Ruby (or, "what Python *really* needs" or "perldoc!")

Colin J. Williams cjw at sympatico.ca
Tue Mar 14 18:53:14 CET 2006


Diez B. Roggisch wrote:
>>Thanks Diez! Epydoc looks great.
>>
>>Can we use epytext to generate output suitable for a manpage?
> 
> 
> Don't know, never tried that.
>  
The answer appear to be No, but there is a man.py file which indicates 
that some work was done on it.

Below is the epydoc commandline guide.

Colin W.

epydoc [OPTIONS] MODULES...

     MODULES...                The Python modules to document.
     --html                    Generate HTML output (default).
     --latex                   Generate LaTeX output.
     --pdf                     Generate pdf output, via LaTeX.
     --check                   Run documentation completeness checks.
     -o DIR, --output DIR      The output directory.
     -n NAME, --name NAME      The documented project's name.
     -u URL, --url URL         The documented project's url.
     -t PAGE, --top PAGE       The top page for the HTML documentation.
     -c SHEET, --css SHEET     CSS stylesheet for HTML files.
     --private-css SHEET       CSS stylesheet for private objects.
     --inheritance STYLE       The format for showing inherited objects.
     -V, --version             Print the version of epydoc.
     -h, -?, --help, --usage   Display this usage message.
     -h TOPIC, --help TOPIC    Display information about TOPIC (docformat,
                               css, inheritance, usage, or version).
> 
>>Do you prefer epytext or reST?
> 
> 
> So far epytext suited my needs.
> 
> Diez



More information about the Python-list mailing list