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.
The indentation of a line is defined as the number of leading spaces on that line; and the indentation of a block is typically the indentation of its first line. The epydoc script can be used to check the completeness of the reference documentation. The copyright information for an object. 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.
Inherited objects are gathered into groups, based on which class they are inherited from.
How can I include graphs in the generated output? The contents of the invalid field are generally ignored. Doctest blocks are delimited from surrounding blocks by blank lines. Whitespace within URL targets is ignored.
These graphs can be included in one of two ways:. Email Required, but never shown. How can I make epydoc go faster? The type of epdoc property.
Fpydoc type information is available about attributes via the type fieldthen those types are displayed as separate classes, and the attributes are displayed as associations. The following example illustrates how URLs can be used:. Epydoc also includes a graphical interface, for systems where command line interfaces are not convenient such as Windows. 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.
But if epytext is not powerful enough for you, or doesn’t suit your needs, epydoc also supports three alternate markup languages:.
Video and audio from the presentation are available for download. In general, spaces and genrate within docstrings are treated as soft spaces. This page is displayed in the lower-left frame of frames. What’s New in Epydoc Epydoc 3.
Docstrings for variables Epydoc now supports variable docstrings. For a list of the fields that are supported by epydoc, see the epydoc fields chapter.
These graphs are based on profiling information, epudoc must be specified using the –pstate option. For example, the following command generates API documentation for the existing regular expression package rewhich uses plaintext markup:.
Text is shown in a monospaced font. To customize the output, click on the “Options” arrow at the bottom of the window. The following example illustrates how fields can be used: Objects can be specified using dotted names such as os.
Epydoc: Frequently Asked Questions
Plaintext docstrings are rendered verbatim preserving whitespace. The following example illustrates how fields can be used: If you would like to use a more expressive markup language, then we recommend using reStructuredTextwhich is easy to write, easy to read, and has support for a generafe wide array of constructs. This page explains how to use and navigate the webpage produced by epydoc. An unindented line immediately following a paragraph starts with a list bullet.
Usually the object name decides the object visibility: For example, the following function defines a docstring: These tags are usually put in a module or class docstring.