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: Gosida Juhn
Country: Peru
Language: English (Spanish)
Genre: Career
Published (Last): 3 February 2005
Pages: 340
PDF File Size: 15.83 Mb
ePub File Size: 3.9 Mb
ISBN: 325-7-58414-112-4
Downloads: 26842
Price: Free* [*Free Regsitration Required]
Uploader: Tolkree

In particular, it will check that every module, class, method, and function has a description; that every parameter has a description and a type; and that every variable has a type. The paragraphs within a block are not left-aligned. Epytext warnings do not prevent the docstring in question from being parsed. The optional caption option can be used to geherate a caption for the graph.

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

In addition, two special escape codes are defined: The following example illustrates how documentation crossreference links can be used: See fpydoc Release Notes on SourceForge. If you’d like more fine-grained control over what gets checked, or epydkc would like to check other fields such as the author or versionthen you should use the DocChecker class directly.

Documentation inheritance for inherited methods and variables. Note that the description is indented four spaces. Italicized text Bold-faced text Source code Math: In particular, object names may be split over multiple lines. They are marked using the todo tag.


Epydoc: What’s New

This a second 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. No descr, No type epydoc.

gfnerate Epydoc’s HTML writer indeed includes such file in its output: Epytext is a simple lightweight markup language that lets you add formatting and structue to docstrings. This is a description of x’s type. The second item of the sublist has its own own sublist.

The following graphs generation constructions are currently defines:. Epydoc uses indexed terms to create a table of terms definitions. The epydoc implementation of Javadoc is based on the Javadoc 1.

What’s New in Epydoc

If you are installing on Windows, I recommended that you use the windows installer. The name of the markup language may optionally be followed by a language code such as en for English. These graphs can be included in one of two ways:.

Multiple note fields may be used to list separate notes. A condition which should always be true for an object. Because Javadoc does not mark end of the optional argument, field arguments must contain exactly one word.

The name of one or more pstat files generated by the profile or hotshot module. The following example which has an unusually high ratio of documentaiton to code illustrates some of the basic features of epytext:. Genedate can be named using dotted names, module filenames, or package directory names. For example, genertae following function defines a docstring: Video and audio from the presentation are available for download. Paragraphs are separated from each other by blank lines.


Using Epydoc

Fields do not need to be separated from other blocks by a blank line. If you want rpydoc hear back when we fix it, be sure to either log generatf to Sourceforge, or include your email address in the bug report.

The following table lists the fields that epydoc currently recognizes. To help you create custom stylesheets, a complete description of the specialized LaTeX commands that epydoc uses to generate its output is available here: Docstring Input Rendered Output def example: Doctest blocks may not contain blank lines.

Bugs are marked using the bug tag. In general, symbols should be used sparingly. If you want to create indexed terms in reStructuredText modules, you can use the term interpreted text role.

The epydoc script extracts API documentation for a set of Python objects, and writes it using a selected output format. This may decrease the amount of information that epydoc can extract from your project. 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.

This typically occurs if inline markup is nested inside the URI target.