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.
|Published (Last):||9 September 2010|
|PDF File Size:||14.19 Mb|
|ePub File Size:||12.87 Mb|
|Price:||Free* [*Free Regsitration Required]|
The following graphs generation constructions are currently defines:. 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.
The Epytext Markup Language
A condition that must be true before an object is used. The heading is contianed in some other block structure such as a list. You want to preceed a matched pair of curly braces with a capital letter. The following example which has an unusually high ratio of documentaiton to code illustrates some of the basic features of epytext: An unindented line epydkc following a paragraph starts with a list bullet. Epydoc automatically creates an index of term definitions for the API documentation.
Each list item is marked by a bullet. Spaces and newlines are preserved. If you want to create a crossreference link to the somemod. The second item of the sublist has its own own epydpc.
If the first contained block generage 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 is a third list item.
Wrong underline character for heading. The second command writes pdf output to the file api.
DottedName the browser will be redirected to the page epydoc. When should I use –parse-only? The following is a doctest block: Doctest block are mostly useful to be run as a part of automatized test suite using the doctest module. The type of the return geenrate for a function or method.
A planned change to an object. First, this ensures that the names of module and class pages do not conflict with the names of existing special pages.
Epydoc: Frequently Asked Questions
The following sections list and describe the warning messages that epydoc can generate. Section 1 This is a paragraph in section 1. Symbols are used to insert special characters in your documentation.
Variables may also be documented using comment docstrings.
If no module is specified, and the directive is used in a module’s docstring, then that generare package hierarchy will be displayed. This eoydoc a sublist. If you want to create a crossreference link to the type, or to write the type in a fixed-width font, then you must use inline markup:.
However, there are likely to be some minor incompatibilities between Sun’s implementation and epydoc’s. The following example illustrates how URLs can be used: Block Structure divides the docstring into nested blocks of text, such as paragraphs and lists.
This is an ordered list item. Also, note that the double colon “:: Multiple note fields may be used to list separate notes. Generwte tag is a case-insensitive word that indicates what kind of documentation is given by the field.
Display a custom Graphviz dot graph.
python – How to generate pdf with epydoc? – Stack Overflow
If the optional argument ver is given, then it specifies the version for which the change will be made. For a description of the errors that can be generated by epydoc, see the epydoc 1 man page.
The following example illustrates how paragraphs can be used: If no class is specified, and the directive is used in a class’s docstring, then that class’s class hierarchy will be displayed. Epytext was carefully constructed to minimize the need for this type of escaping; but sometimes, it is unavoidable. This is a description of the parameter x to a function. Epydoc will be installed in the epydoc subdirectory of your Python installation directory typically C: Several fields have synonymsor alternate tags.
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. If venerate consolidated field is written as a bulleted listthen each list item must begin with the field’s argument, marked as interpreted textand followed by a colon or dash.