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: Gazilkree Kebei
Country: Trinidad & Tobago
Language: English (Spanish)
Genre: Career
Published (Last): 20 December 2009
Pages: 450
PDF File Size: 12.40 Mb
ePub File Size: 10.57 Mb
ISBN: 590-5-42406-324-6
Downloads: 25343
Price: Free* [*Free Regsitration Required]
Uploader: Marisar

Block structure is encoded using indentation, blank lines, and a handful of special character sequences. Currently, the graphical interface can only generate HTML output. This list item contains two paragraphs and a doctest block. Email Required, but never shown. No descr, No type epydoc.

Epydoc: What’s New

Configuration files, specified using the –config option, may be used to specify both the list of objects to document, and the options that should be used to document them.

Each list item is marked by a bullet. All of the blocks contained by a field must all have equal indentation, and that indentation must be greater than or equal to the indentation of the field’s tag.

Why does epydoc use both introspection and parsing?

Using Epydoc

If no module is specified, and the directive is used in a module’s docstring, then that module’s import graph will be displayed. This a second list item. Characters in a docstring that are not involved in markup are called content characters.


If you want to create a crossreference link to the somemod.

Gfnerate a new question The following table lists the fields that epydoc currently recognizes. Block Structure divides the docstring into nested blocks of text, such as paragraphs and lists. Increase -v or decrease -q the verbosity of the output.

Whitespace within URL targets is ignored. Fields may be included in any order. This sentence ends with the number 1. Epydoc can also be accessed programmatically; see epydoc’s API documentation for more information.

If the current module is contained in a package, then epydoc will also try importing the given name from all packages containing the current module.

Improvements to Efficiency Epydoc 2. The default value is 0; negative values will supress warnings and errors; positive values will give more verbose output.

Frequently Asked Questions

For more yenerate, see the epydocgui 1 man page. The body of the directive graph If you wish to use a more expressive markup language, I recommend reStructuredText.

Displays each class’s base classes and subclasses. Note that there is no valid Python expression where a pair of matched curly braces is immediately preceeded by a capital letter except within string literals. If you intended the former, then indent the list. The format that should be used to display inherited methods, variables, and properties. Generste index term is a term that should be included in the index.


However, you do need to escape curly braces when:.

Methods and attributes are listed in the classes where they are defined. The second command writes pdf output to the file api.

Epydoc does not support the Javadoc block tag serial. The following example illustrates how escaping can be used:. DottedName the browser will be redirected to the page epydoc.

To include all graphs, use –graph all. Objects can be named using dotted names, module filenames, or package directory names. Fields must be the final elements in an epytext string. The name fragment is looked for in the names defined in the description file: If no class is specified, and the directive is used in a class’s docstring, then that class’s class hierarchy will be displayed.

Epydoc: Frequently Asked Questions

There are two reasons. The following example illustrates a simple ordered list. See Configuration Gejerate for more information. If a consolidated field is written as a bulleted listthen each list item must begin with the field’s argument, marked as interpreted textand followed by a colon or dash.

The heading is a single underlined line of text.

Author: admin