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: Gardalkree Kagara
Country: Bulgaria
Language: English (Spanish)
Genre: Relationship
Published (Last): 28 March 2018
Pages: 479
PDF File Size: 3.84 Mb
ePub File Size: 9.58 Mb
ISBN: 662-5-19638-370-3
Downloads: 12425
Price: Free* [*Free Regsitration Required]
Uploader: Akinogami

Using Epydoc

Generatf example, a single: For each object that fails a check, epydoc will print a warning. Improvements to Inspection Support for new Python 2. For more information, see the epydocgui 1 man page. This typically occurs generaet the trailing colon: So in most cases, you can use curly braces in your text without any form of escaping. If no object is found that corresponds with the given name, then epydoc issues a warning.

If PATH does not exist, then it will be created. Epytext will treat any line that begins with a bullet as a list item. Why does epydoc use both introspection and parsing? Epydoc does not support the Javadoc block tag serial.

The following sections describe how to use each type of block structure. List items can contain more than one paragraph; and they can also contain sublists, literal blocksand doctest blocks. For a description of the errors that can be generated by epydoc, see the epydoc 1 man page. The command line interfacewhich is accessed via a script named epydoc or epydoc. This is another ordered list item.


The organization that created or maintains an object. Modules can be named using dotted names, module filenames, or package directory names.

The Epytext Markup Language

Variables may also be documented using comment docstrings. While the language doesn’t directly provides for them, Epydoc supports variable docstrings: In general, symbols should be used sparingly.

In particular, loading the page ” redirect. Paragraphs are separated by blank lines. Literal blocks are used to represent “preformatted” text. Sign up or log in Sign up using Google.

The following example shows how doctest blocks can be used: Displays each class’s base classes and subclasses. It should be one of: A paragraph is the simplest type of basic block. For a list of the fields that are supported by epydoc, see the epydoc fields chapter. Fenerate precondition fields may be used if an object has multiple preconditions.

The following example ggenerate how paragraphs can be used: Epydoc considers class variables the ones defined directly defined in the class body. The term classifier, if present, is used to specify the associated type. Objects can be specified using dotted names such as ” os.

These generaate are usually put egnerate the the docstring of the function to be documented. For example, consider the following example: Inline Markup marks regions of text within a basic block with properties, such as italics and hyperlinks.


Source code or a Python identifier. Support for new Python 2. The following example configuration file demonstrates the various options that you can set.

If Docutils is not installed, then reStructuredText docstrings will be rendered as plaintext. This typically occurs if inline markup is nested inside the URI target.

For example, consider the following example:. For more information, see the definition of field syntax for each markup language.

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

The following custom directives are currently defined:. I suppose that you used an existing conf file. Paragraphs must be left justified i.

These options may be repeated to further increase or decrease verbosity. The name of the markup language may optionally be followed by a language code such as en for English.

My Cool Project url: Next, epydoc looks for an object with the given name in the current module. For an example of epydoc’s output, see the API documentation for epydoc itself htmlpdf. A list of the Epgdoc objects that should be documented.

This option may be used multiple times, if you wish to use multiple configuration files. You want to include a single un-matched curly brace. Fields do not need to be generats from other blocks by a blank line.