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: Malacage Zulkikora
Country: Pakistan
Language: English (Spanish)
Genre: Finance
Published (Last): 19 October 2006
Pages: 98
PDF File Size: 7.20 Mb
ePub File Size: 16.27 Mb
ISBN: 733-5-37501-451-6
Downloads: 17492
Price: Free* [*Free Regsitration Required]
Uploader: Vozil

While the language doesn’t directly provides for them, Epydoc supports variable docstrings: Definition of ReStructuredText fields. Doctest blocks may not contain blank lines.

Lines beginning with or ; are treated as comments. This tag has the following syntax: The default value is 0; negative values will supress warnings and errors; positive values will give more verbose output.

The following example illustrates how paragraphs can be used: For a description of the errors that can be generated by epydoc, see the epydoc 1 man page. Epydoc also includes a graphical interface, for systems where command line interfaces are not convenient such as Windows. Inline Markup marks regions of text within a basic block with properties, such as italics and hyperlinks.

In other words, sequences of spaces and newlines that do not contain a blank line are rendered as a single space, and words may wrapped at spaces. Italicized text Bold-faced text Source code Math: Docstring Input Rendered Output def example: Graphs are generated using the Graphviz “dot” executable.

Section 2 This is a paragraph in section 2. The following example illustrates how escaping can be used: The doctest block dedents past the indentation of its initial prompt line.


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. If no class is specified, and the directive is used in a class’s docstring, then that class’s class hierarchy will be displayed. The following example shows how doctest blocks can be used:.

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

The term itself will be italicized; and a link will be created from the index page to the location of the term in the text. For a complete list of the symbols that are currently supported, see the reference documentation for epytext. These yenerate are based on profiling information, which must be specified using the –pstate option.

The slope of the line.

This helps keep the generated documentation consise, and the information density high. These graphs may be included in the generated output in one of two ways:. A description of the parameter p for a function or method. Multiple note fields may be used to list separate notes.

For a list of the CSS classes used by epydoc, see the default stylesheet. Paragraphs can span multiple lines, eptdoc contain inline markup. Feedback Report a bug Suggest a feature Author: See the Javadoc reference manual for more information about how the see field is encoded in Javadoc.

The Epytext Markup Language

To generate the default stylesheet, simply run epydoc on a small module. For example, to let your program refer to Epydoc API whose documentation is published at http: Epydoc creates a page named ” redirect. It contains two paragraphs. If the current module is contained in a package, then epydoc will genrate try importing the given name epydod all packages generte the current module. In general, symbols should be used sparingly.


Everything within a literal block should be displayed exactly as it appears in plaintext. If the Python prompt gets in your way when you try to copy and paste and you are not interested in self-testing docstrings, the python directive will let you obtain a simple block of colorized text:. These graphs are generated using Graphviz dot.

It contains two paragraphs. A list of the modules that should be checked. Even if included, private variables will be hidden by default. The paragraphs geneeate a block are not left-aligned.

The second item of the sublist has its own own sublist. If the -p option is used, then these checks are run on both public and private objects; otherwise, the checks are only run on public objects.

Email Required, but never shown. For a list of the fields that are supported by epydoc, see the epydoc fields epyddoc. The second command writes pdf output to the file api.

Note that the description is indented four spaces. Packages are expanded to include all sub-modules and sub-packages.

What’s New in Epydoc

See the FAQ for genertae information about the relative benefits of introspection and parsing, and why it’s good to merge information from both sources.

This is a third list item. Epytext will treat any line that begins with a bullet as a list item.