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: Vulrajas Malami
Country: Thailand
Language: English (Spanish)
Genre: Career
Published (Last): 8 October 2004
Pages: 374
PDF File Size: 10.43 Mb
ePub File Size: 3.54 Mb
ISBN: 716-1-76957-998-7
Downloads: 87333
Price: Free* [*Free Regsitration Required]
Uploader: Fenrik

The Epytext Markup Language

So in most cases, you can use curly braces in your text without any form of escaping. The following example illustrates how URLs can be genertae. Inherited objects are gathered into groups, based on which class they are inherited from. For a more extensive example of epydoc’s output, see the API documentation for Python 2. Epydoc can also be accessed programmatically; see epydoc’s API documentation for more information.

The graphical generaye can be invoked with the epydocgui command, or with epydoc. The following example illustrates how escaping can be used:. Epydoc LaTeX Style Reference Additionaly, you may find it useful to look at the builtin style files that epydoc provides: If the first contained block is a paragraph, it may appear on the same line as the bullet, separated from the bullet by one or more spaces, as shown in the previous example.

You can specify which stylesheet epydox be used using the -c command-line option. Objects can be named using dotted names, module filenames, or package directory names. A matching pair of curly braces is only interpreted as inline markup if the left brace is immediately preceeded by a capital letter. Epydoc also understands docstrings written in reStructuredTextJavadoc, and plaintext.


Such file can be used to create external API links. The expected type for the parameter p. Methods and attributes are listed in the classes where they are defined. You should periodically update your copy of the subversion repository, to make sure you have all the latest changes:. Whitespace within object names is ignored. Currently, the graphical interface can only generate HTML output.

Epydoc: What’s New

A summary description for an object. For a description of the errors that can be generated by epydoc, see the epydoc 1 man page.

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: The following example illustrates how paragraphs can be used:.

The page also contains the list of the options enabled when the documentation was created.

Epytext will treat any line that begins with a bullet as a list item. Doctest blocks are delimited from surrounding blocks by blank lines. If you find any bugs, or have suggestions for improving it, please report them on sourceforge.

Epydoc: Frequently Asked Questions

This is a second list item. Some module variables are commonly used as module metadata. The markup language that should be used by default to process modules’ docstrings. However, within literal blocks and doctest blocks, spaces and newlines are preserved, and no word-wrapping occurs; and within URL targets and documentation link targets, whitespace is ignored. Epydoc can be used to create hyperlinks from your package documentation towards objects defined in the API of other packages.

The name of one or more pstat files generated by the profile or hotshot module. Can be a URL, the name of a module or class, or one of the special names “trees. Fields may be included in any order. For example, if your program needs to programmatically use the Epydoc package itself, your docstrings may refer to functions described by Epydoc API:. In particular, URL targets may be split over multiple lines.


If the current module is contained in a package, then epydoc will also try importing the generafe name from all packages containing the current module. Notice that variable docstrings are only available for documentation when the source code is available for parsing: Display an import graph for the given module or modules.

Using Epydoc

However, if you wish, you can tell epydoc to use only one or the other of these methods. They are intended as a reference resource, which you can search for more information and possible causes if you generaet an error and do not understand it.

Wrong underline character for heading.

The length of the underline must exactly match the length of the heading. Multiple requires fields may be used if an object has multiple requirements. Once you have added all of the modules that you wish to document, press the “Start” button.

Any children that are not included in this list will appear after the children from this list, in alphabetical order.

The following example illustrates how the four basic markup types can be used: 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.