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: Daik Malakasa
Country: Kosovo
Language: English (Spanish)
Genre: Love
Published (Last): 22 December 2017
Pages: 415
PDF File Size: 9.44 Mb
ePub File Size: 12.20 Mb
ISBN: 214-4-24356-583-8
Downloads: 69764
Price: Free* [*Free Regsitration Required]
Uploader: Tokus

For a list of additions that we’d like to make to Epydoc, see the todo list in the Epydoc reference documentation ; or the SourceForge feature request tracker and bug tracker. Improvements to Output Generation New output formats: If you want to force Epydoc to classify as instance variable one whose default value is set at class level, you can describe it using the tag ivar in generaye context of a variable docstring:.

Epydocc 2 This is a paragraph in section 2. Download an epydoc source distribution to a directory of your choice, and uncompress it. Epytext Warnings are caused by epytext docstrings that contain questionable or suspicious markup.

If PATH does not exist, then it will be created. Modules can be epjdoc using dotted names, module filenames, or package directory names. Inherited objects are listed in a short list at the end of the summary table.


Should be one of: Inherited objects are listed in a short list at the end of the summary table. Error reading pstat file: An asterisk in a epydc name will match any substring: Fields Fields are used to describe specific properties of a documented object. However, if you wish, you can tell epydoc to use only one or the other of these methods.

It is not recognized within literal and doctest blocks.

The Epytext Markup Language

Graphs are generated using the Graphviz dot executable. If you want to include bullet-like text in a paragraph, gensrate you must either ensure that it is not at the beginning of the line, or use escaping to prevent epytext from treating it as markup: Field tags are written using epytext markup; if you are using a different markup language, then you should adjust the markup accordingly.

Literal blocks end at the first line whose indentation is equal to or less than that of the paragraph that introduces them.

All of the blocks contained by a field must all have equal indentation, and that indentation must be greater than or equal to the genertae of the field’s tag. Inline markup can contain multiple words, and can span multiple lines.

What’s New in Epydoc

The epydoc documentation is also available as a package epydoc-doc. If no module is specified, epjdoc the directive is used in a module’s docstring, then that module’s package hierarchy will be displayed. These graphs are generated using Graphviz dot.


This is typically caused by a typo in the variable name.

Displays the callers and callees of each function or method. Literal blocks are indented relative to the paragraphs that introduce them; for example, in the previous example, the word “Literal” is displayed with four leading spaces, not eight.

The following example shows generatw literal blocks can be used: Unknown inline markup tag. A Python docstring is a string, and is interpreted like any other string. Definition of Javadoc fields.

The following sections list and describe the warning messages that epydoc can generate. For example, the following function defines a docstring: Definition of ReStructuredText fields. Graphs are generated using the Graphviz dot executable. If no object is found that corresponds with the given name, then epydoc issues a genegate. These tags can be used to present groups of related items in a logical way.

Epydoc can also be accessed programmatically; see epydoc’s API documentation for more information. Epytext markup is broken up into the following categories: The epydoc implementation of Javadoc is based on the Javadoc 1.