Skip to content

Latest commit

 

History

History
26 lines (17 loc) · 728 Bytes

epytext.rst

File metadata and controls

26 lines (17 loc) · 728 Bytes

Epytext

.. toctree::
    :maxdepth: 1

    epytext_demo/index

Read the the epytext manual for full documentation.

Pydoctor has extended epydoc's parser and uses it as a library to parse epytext formatted docstrings.

All markup should work except the indexed terms X{} tag, which has been removed.

Fields

See :ref:`fields section <codedoc-fields>`.

Note

Not everything from the epydoc fields manual is applicable. Some fields might still display as unknown.

Note

In any case, plaintext docstring format will be used if docstrings can't be parsed with epytext parser.