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: Doukasa Migul
Country: Jamaica
Language: English (Spanish)
Genre: Spiritual
Published (Last): 21 January 2014
Pages: 304
PDF File Size: 7.24 Mb
ePub File Size: 12.98 Mb
ISBN: 889-5-21739-243-7
Downloads: 71061
Price: Free* [*Free Regsitration Required]
Uploader: Mujinn

For example, consider the following example:. Spaces and Newlines In general, spaces and newlines within docstrings are treated epyroc soft spaces. The list of fields parametc.

python – How to generate pdf with epydoc? – Stack Overflow

For example, a single: For example, if you are running epydoc on untrusted code, you should use the –parse-only option. It should be one of: Of course this doesn’t help to really create cross references: Epytext is a lightweight markup language for Python docstrings.

The epydoc graphical interface can save and load “project files”, which record the set of modules epycoc the options that you have selected. I think that maybe I am missing latex but I am not very familliar with tex and latex.


Frequently Asked Questions

The organization that created or maintains an object. But if epytext is not powerful enough for you, or doesn’t suit your needs, epydoc also supports three alternate markup languages:. You can specify which stylesheet should be used using the -c command-line option.

Definition of Javadoc fields. Multiple contact fields may be used if an object has multiple contacts. This a second list item. The copyright information for an object. The second item of the sublist has its own own sublist. Lists must be indented. Epydoc then tries to import the given name as a module. If no function is specified, and the directive is used in a geneate docstring, then that function’s call graph will be displayed. Note that there is no valid Python expression where a pair of matched curly braces is immediately genearte by a capital letter except within string epydooc.

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.

Epydoc does not support the following Javadoc inline tags: Which markup language do you recommend? If the sources can be parsed by Epydoc it is also possible to document the variable in generatw own docstrings: It looks ok to me and is working fine when I am generating html document. A common Python idiom is to create instance variables settings their default value in the class instead of the constructor hopefully if the default is immutable In the previous example you can use: The field tag tag was used with an argument, but it does not take one.


Fields may be included in any order. The page also contains the list of the options enabled when the documentation was created. Epytext supports both ordered and unordered lists. 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.

Special character sequences are used dpydoc mark the beginnings of some blocks.

The Epytext Markup Language

See the documentation for fields for more information. On Windows, this script is named epydoc. Everything within a literal block should be displayed exactly as it appears in plaintext. Fields must be the final elements in generqte epytext string. The following list describes each of the files generated by epydoc:.