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):||8 April 2016|
|PDF File Size:||13.52 Mb|
|ePub File Size:||1.91 Mb|
|Price:||Free* [*Free Regsitration Required]|
Eypdoc following example which has an unusually high ratio of documentaiton to code illustrates some of the basic features of epytext: If you wish to use a more expressive markup language, I recommend reStructuredText.
Contact information for the author or maintainer of a module, class, function, or method. The page also contains the list of geneeate options enabled when the documentation was created. Run epydoc with the -v option to see markup errors, and check for an error in the docstring in question.
The Epytext Markup Language
A type field was used to specify the type for a parameter that is not included in the function’s signature. If you wish to keep up on the latest developments, you can also get epydoc from the subversion repository. Paragraphs are separated by blank lines.
The following table shows the basic fields syntax for each markup language. Every Python module and class is documented in its own file. The copyright information for an object. Without the capital letter, matching braces are not interpreted as markup: The corresponding config file option is redundant-details.
Lists must be indented. The following is a doctest block: This is an ordered list item. The child blocks can be paragraphs, lists, literal blocks, doctest blocks, or sections. Inline markup may be nested ; and it may span multiple lines.
This is a sublist. Source code or generaate Python identifier. Epydoc replaces the Docutils’ default interpreted text role with the creation of documentation crossreference links.
Epydoc: What’s New
If you intended the former, then indent the list. Epydoc LaTeX Style Reference Additionaly, you may find it useful to look at the builtin style files epydpc epydoc provides: You can add new fields that describe simple metadata using the newfield field.
If you want to create indexed terms in reStructuredText modules, you can use the term interpreted text role. A more complete exampleincluding all of the supported options, is also available.
Frequently Asked Questions
Doctest blocks are delimited from surrounding blocks by blank lines. A description of a related topic. A blank line is a line that only contains whitespace.
Improper doctest block indentation. But if epytext is not powerful enough for you, or doesn’t suit your needs, epydoc also supports three alternate markup languages:.
These graphs may be included in the generated output in one of two ways:. Graphs are generated using the Graphviz dot executable. A docstring contains a field with the unknown tag tag.
For a complete list of the symbols that are currently supported, see the reference documentation for epytext. This is a third list item.