Closed peterjc closed 6 years ago
I'd support this solely based on the ability to then use pdoc --http
to view the 'canonical' doc format (that of the standard library, and whatever copies its format of choice).
Hi there! We've decided that support for markup format beyond markdown is not a goal at this point. We feel this is the best way for pdoc to remain a small, clear, predictable tool.
Please see #153 for a unified discussion ticket about docstring flavors.
According to the README,
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:
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.
or,
or