Join GitHub today
GitHub is home to over 36 million developers working together to host and review code, manage projects, and build software together.
Sign up__docformat__ reStructuredText/rst etc input as well as Markdown #111
Comments
This was referenced Jul 29, 2016
Closed
This was referenced Aug 24, 2017
This was referenced Sep 7, 2017
Closed
This comment has been minimized.
This comment has been minimized.
automaticgiant
commented
May 2, 2018
|
I'd support this solely based on the ability to then use |
This comment has been minimized.
This comment has been minimized.
|
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. |
cortesi
closed this
Jun 1, 2018
This comment has been minimized.
This comment has been minimized.
|
Please see #153 for a unified discussion ticket about docstring flavors. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
peterjc commentedJul 29, 2016
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