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):||3 February 2004|
|PDF File Size:||13.74 Mb|
|ePub File Size:||18.9 Mb|
|Price:||Free* [*Free Regsitration Required]|
Display an import graph for the given module or modules. The following example illustrates how index terms can be used:. Notice that variable docstrings are only available for documentation when the source code is available for generare The following example illustrates how documentation crossreference links can be used:. Fields are used to describe specific properties of a documented object.
Use “all” to include all graph types graph: The following example which has an generae high ratio of documentaiton to code illustrates some of the basic features of epytext:. I suppose that you used an existing conf file.
The following example illustrates how paragraphs can be used:. By default, source code is rendered in a fixed width font; and mathematical expressions are rendered in italics. Where tag is the new tag that’s being defined; label is a string that will be used to mark this field in the generated output; and plural is the plural form of label, if different.
The following example illustrates how paragraphs can be used:. To see an example of each graph type, click on it: See Configuration Files for more information.
A description of a related topic. It is available clicking on the timestamp below each page, if the documentation was created using the –include-log option. A lightweight markup language called epytext can be used to format docstrings, and to add information about specific fields, such as parameters and instance variables.
The term itself will be italicized; and a link will be created from the index page to the location of the term in the text. Doctest blocks can be used by the doctest module to test the documented object.
If this executable is not on the path, then use epyvoc to specify its location. This is a sublist. This is a list item. In addition to the standard set of fieldsthe reStructruedText parser also supports consolidated fieldswhich combine the documentation for several objects into a single 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:.
Frequently Asked Questions
This tag has the following syntax: This paragraph ends with two colons, but does not introduce a literal block:: Every Python module and class is documented in its own file.
Graphs are generated using the Graphviz “dot” executable. If any todo field is used, the HTML writer will generate a the page todo-index. Improvements to Inspection Support for new Python 2.
The Epytext Markup Language
Multiple field tags define the value of field in the same docstring, but field can only take a single value. The return value for a function or method. Its paragraph is indented 7 genedate. The following example configuration file demonstrates the various options that you can set. The current version of an object. For example, consider the following example:. The available graph types are:. The following example illustrates how documentation crossreference links can be used: 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 gnerate field’s tag.
If no class is specified, and the directive is used in a class’s docstring, then that class’s class hierarchy will be displayed. Multiple todo fields may be used if multiple changes are planned. If the Python prompt gets in your way when you try to copy and paste and you are not interested in self-testing docstrings, the python directive will let you obtain a simple block of colorized text:.
It looks ok to me and is working fine when I am generating html geneeate. If no function is specified, and the directive is used in a function’s docstring, then that function’s call graph will be displayed.
No descr, No type epydoc.
Why does epydoc render one of my epytext-formatted docstrings as plaintext? A list of the Python objects that should be documented. The following example which has geberate unusually high ratio of documentaiton to code illustrates some of the basic features of epytext: Note that the description is indented four spaces. If you want to force Epydoc to classify as instance variable one whose default value is set at class level, you can describe it using the tag ivar in the context of a variable docstring:.
Ask a new question Section 2 This is a paragraph in section 2.