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.
|Published (Last):||10 April 2006|
|PDF File Size:||16.58 Mb|
|ePub File Size:||11.94 Mb|
|Price:||Free* [*Free Regsitration Required]|
My Cool Project url: This page is displayed in the upper-left frame of frames. Epydc may also be documented using comment docstrings. The available graph types are: Doctest blocks may not contain blank lines.
A note about an object. Epytext reStructuredText Javadoc tag: You can compare this function definition with the API documentation generated by epydoc.
The epydoc graphical interface can save and load “project files”, which record the set of modules and the options that you have selected. Graphs are generated using the Graphviz “dot” executable.
The white CSS style is used; inheritance is displayed using the listed style; and all graphs are included in the output.
First, this ensures that the names of module and class pages do not conflict with the names of existing special pages. The following commands are used to produce the API documentation for epydoc itself.
Each list item is marked by a bullet. Each field consists of a tagan optional argumentand a body.
The Epytext Markup Language
Inherited objects are mixed in with non-inherited objects. A list consists of one or more consecutive list items of the genedate type ordered or unorderedwith the same indentation. This is a description of x’s type. Inherited objects are listed in a short list at the end of the summary table.
The following example shows how doctest blocks can be used:. Everything after the first noise character for example after an ‘ ‘ is discarded. Example class, you can put backquotes around your test, typing:. eppydoc
In addition, two special escape codes are defined: Error reading pstat file: Furthermore, epydoc can combine documentation information obtained from these two sources. Note that sublists must be separated from the blocks in their parent list item by indentation.
This is an ordered list item. Epydoc then tries to divide the given name into a module name and an object name, and to import the object from the module. Epydoc creates a CSS stylesheet epydoc. Finally, epydoc looks for a class name in any module with the given name. Epytext can’t tell if the “1. The following example illustrates how escaping can be used:.
This may decrease the amount of information that epydoc can extract from your project. The underline character used for this section heading does not indicate an appopriate section level. To customize the output, click on the “Options” arrow at the bottom of the window.
The Epytext Markup Language
Inline markup is recognized within paragraphs and section headings. In addition to the standard set of fieldsthe reStructruedText parser also supports consolidated fieldswhich combine the documentation for several objects into a single field.
Paragraphs must be left justified i. Improvements to Inspection Support for new Python 2. They apply to modules and classes docstrings. This is a description of the function’s return value.
Multiple attention fields may be used to list separate notes. It contains two paragraphs. Methods and attributes are listed in the classes where they are defined. However, there are likely to be some minor incompatibilities between Sun’s implementation and epydoc’s.