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: Shaktizragore Grodal
Country: Canada
Language: English (Spanish)
Genre: Art
Published (Last): 22 February 2014
Pages: 315
PDF File Size: 13.66 Mb
ePub File Size: 8.82 Mb
ISBN: 325-7-83976-210-1
Downloads: 14689
Price: Free* [*Free Regsitration Required]
Uploader: Dujar

DottedName the browser will be redirected to the page epydoc. Literal blocks are introduced by paragraphs ending in the special sequence “:: These descriptions are also available in the epydoc 1 man page. The sublist ephdoc two items. Text is shown in a monospaced font. Python don’t support directly docstrings on variables: The paragraph may be indented more than the list item’s bullet; often, the paragraph is intended two or three characters, so that its left margin lines up with the right side of the bullet.

See Configuration Files for more information. However, you do need to escape curly braces when: More over I genertae working on Windows. Modules can be named using dotted names, module filenames, or package directory names.

Frequently Asked Questions

generatee Characters in a docstring that are not involved in markup are called content characters. Feedback Report a bug Suggest a feature Author: Ephdoc combines the information obtained from these two methods to provide more complete and accurate documentation. These consolidated fields may be written using either a bulleted list or a definition list. Finally, epydoc looks for a class name in any module with the given name. The second item of the sublist has its own own sublist.

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 epydc its first line. It consists of HTML, augmented by a set of special tagged fields. If you wish to keep up on the latest developments, you can also get epydoc from the subversion repository. The white CSS style is used; inheritance is displayed using the listed style; and all graphs are included in the output.


Note that the description is indented four spaces. Block structure is encoded geenrate indentation, blank lines, and a handful of special character sequences. The –parse-only option instructs epydoc to only get documentation information from parsing and not from introspection.

If you’d like, you can create shortcuts from these scripts to more convenient locations such as your desktop or start menu. Literal Blocks Literal blocks are used to represent “preformatted” text. For a list of the CSS classes used by epydoc, see the default stylesheet. No descr, No type epydoc. For example, if your program needs to programmatically use the Epydoc package itself, your docstrings may refer to functions described by Epydoc API: The following example shows how doctest blocks can be used:.

The optional argument specifies what object, parameter, or group is documented by the field. If you want to include bullet-like text in a paragraph, then you must either ensure that it is not at the beginning of the line, or use escaping to prevent epytext from treating it as markup: When an external API link is to be created, the required name is split along any separator ‘.

This sentence ends with the number 1. 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. Displays each class’s base classes and subclasses, using UML style. So in most cases, you can use curly braces in your text without any form of escaping.


The Epytext Markup Language

For example, the following command generates API documentation for the existing regular expression package rewhich uses plaintext markup:. Use “–help topics” for a list of available help topics Generation Options: Symbols Symbols are used to insert special characters in your documentation.

This opens the options pane, which contains fields corresponding to each command line option. The length of the underline must exactly match the length of the heading.

Literal blocks are indented relative to the paragraphs that introduce them; for example, in the previous example, the word “Literal” is displayed with four leading spaces, not eight. You can browse the subversion repository here.

Epydoc: Frequently Asked Questions

Currently, the graphical interface can only generate HTML output. The epydoc documentation is also available as a package epydoc-doc.

These graphs are based on profiling information, which must be specified using the –pstate option. Added –ignore-param-mismatch option, which supresses warnings about parameter mismatches Fixed bug in path magic for epydoc.

Development of Epydoc I’ve found a bug in epydoc! Epydc will be rendered verbatim.

Using Epydoc

Imports the documentation from another object. A type field was used to specify the type epyodc a parameter that is not included in the function’s signature.

The following example illustrates how symbols can be used to generate special generafe. The white CSS style is used; inheritance is displayed using the listed style; and all graphs are included in the output.

If the name is not found, or if it matches with the trailing part of many defined names, a warning is raised and the name is rendered as literal text.