Why does epydoc render one of my epytext-formatted docstrings as plaintext? How can I exclude a specific object from the generated documentation?. The epytext markup language is used by epydoc to parse docstrings and create In particular, the following docstring generates an error, since the sublist is not . Epydoc can automatically generate a variety of graphs, including class tress, package trees, uml class graphs, and import graphs. These graphs may be.

Author: Bralabar Taran
Country: Mali
Language: English (Spanish)
Genre: Business
Published (Last): 28 March 2012
Pages: 97
PDF File Size: 10.87 Mb
ePub File Size: 11.42 Mb
ISBN: 268-7-69334-582-2
Downloads: 84042
Price: Free* [*Free Regsitration Required]
Uploader: Bagul

Will you add support for my favorite markup language xyz? Epytext markup is broken up into the following categories:.

python – How to generate pdf with epydoc? – Stack Overflow

For rpydoc complete list of the symbols that are currently supported, see the reference documentation for epytext. They apply to modules and classes docstrings.

This sentence ends with the number 1. If type information is available about attributes via the type fieldthen those types are displayed as separate classes, and the attributes are displayed as associations. Use make install in the eydoc If no module is specified, and the directive is used in a module’s docstring, then that module’s import graph will be displayed.


Epydoc also understands docstrings written in reStructuredTextJavadocand plaintext.

Using Epydoc

In particular, you never need to escape braces when writing Python dictionaries. Text is shown in a monospaced font. With such tool you will be able to create hypertextual documentation of your package with direct links to its API.

Currently, three styles are supported. The script exposes the same interface of the standard Docutils script rst2html.

It is more powerful than epytext e. So in most cases, you can use curly braces in your text without any form of escaping.

Overview Epydoc is a tool for generating API documentation for Python modules, based on gennerate docstrings. If you plan to make several changes, we could also add you as a developer on Sourceforge. This is only returned if there is a single class with such name. Literal blocks are indented relative to the paragraphs that introduce them; for example, in the previous example, the word “Literal” is genefate with four leading spaces, not eight.

Epydoc provides the script apirst2html. Whitespace within object names is ignored.

Epydoc now supports variable docstrings. Any Python object modules, classes, functions, variables Three new formats for displaying inherited methods and variables: The CSS stylesheet can be used to modify the colors, fonts, and styles that are used by epydoc.

Escaping Escaping is used to write text that would otherwise be interpreted as epytext markup. This is important because each source has its own advantages and disadvantages with respect to the other. The epydoc script can be used to check the completeness of the reference documentation. Literal blocks are indented relative to the paragraphs that epydc them; for example, in the previous example, the word “Literal” is displayed with four leading spaces, not eight.


To include all graphs, use –graph all. The command line interface, which is accessed via a script named epydoc or epydoc.

Whitespace within URL targets is ignored. To help you create custom stylesheets, a complete description of the specialized LaTeX commands that epydoc uses to generate its output is available here:. Currently, generqte graphical interface can only generate HTML output. Unknown field tag tag. If no function is specified, and the directive is used in a function’s docstring, then that function’s call graph will be displayed. Second, it is possible to define a package where a module and a class share the same name.

Bullets for ordered list items consist of a series of numbers followed by periods, such as