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):||20 March 2007|
|PDF File Size:||8.76 Mb|
|ePub File Size:||8.76 Mb|
|Price:||Free* [*Free Regsitration Required]|
Spaces and Newlines In general, spaces and newlines within docstrings are treated as soft spaces. Descriptions of parameters, return values, and types epjdoc marked with ” field: Docstring markup warnings are supressed unless -v is used at least once. Epydoc can also be accessed programmatically; see epydoc’s API documentation for more information.
The sublist contains two items. Epytext is a lightweight markup language for Python docstrings. All of the blocks contained by a field must all have equal indentation, and that indentation must be greater than or equal to the indentation of the field’s tag.
You should use this option if:. You want to preceed a matched pair of curly braces with a capital letter.
Epydoc: What’s New
In gneerate previous example you can use: The expected type for the parameter p. The available graph types are:. Docstring Input Rendered Output. These are used to generate call graphs.
Epydoc: Frequently Asked Questions
Text is shown in a epyoc font. The following example shows how doctest blocks can be used:. What should be the next steps for making epydoc generating pdf file? Displays each class’s base classes and subclasses, using UML style. Objects can be specified using dotted names such as os. Sign up using Email and Password.
You want to include a single un-matched curly brace. Spaces and newlines are preserved. The term classifier, if present, is used to specify the associated type.
It consists of HTML, augmented by a set of special tagged fields.
I think that maybe I am missing latex but I am not very familliar with tex and latex. They are marked using the todo tag. The copyright information for an object. An unindented line geberate following a paragraph starts with a list bullet.
The following example illustrates how the four basic markup types can be used: Epydoc also understands docstrings written in reStructuredTextJavadocand plaintext. The following table lists all field synonyms. The doctest block dedents past the indentation of its rpydoc prompt line.
Epytext Errors are caused by epytext docstrings that contain invalid markup. The following table lists the fields that epydoc currently recognizes. This helps Epydoc to create relative urls: Improvements to Inspection Support for new Python 2. For a description of the errors that can be generated by epydoc, see the epydoc 1 man page. Epytext reStructuredText Javadoc tag: Inherited objects are listed in a short list at the end of the summary table.
In particular, HTML codes are not passed through. The following example illustrates how documentation crossreference links can be used: However, if you wish, you can tell epydoc to use only one or the other of these methods.
However, if you wish, you can tell epydoc to use only one or the other of these methods. The length of the underline must exactly match the length of the heading.
The Epytext Markup Language
This is a third list item. This is a paragraph. No, but you can!