Skip to content

__docformat__ reStructuredText/rst etc input as well as Markdown #111

@peterjc

Description

@peterjc

According to the README,

It is intended that pdoc will be a replacement for the unmaintained epydoc.

epydoc defaults to its own simple epytext markup but supports additional markup languages, reStructuredText, Javadoc and plaintext:

http://epydoc.sourceforge.net/epydoc.html#alternate-markup-languages

They specifically recommend using reStructuredText if epytext is not expressive enough:

Epytext is intentionally very lightweight. If you wish to use a more expressive markup language, I recommend reStructuredText.

http://epydoc.sourceforge.net/epydoc.html#the-epytext-markup-language

I am surprised to see that currently pdoc appears to assume the docstrings are written using Markdown notation (which is not supported by epydoc).

Would you consider supporting other markup languages (I would particularly like to use reStructuredText aka rst) as indicated by the __docformat__ attribute support and/or a command line switch as in epydoc?

e.g.

__docformat__ = "restructuredtext en"

or,

__docformat__ = "plaintext en"

or

__docformat__ = "epytext"

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions