Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
peterjc opened this issue Jul 29, 2016 · 3 comments

Comments

Projects
None yet
3 participants
@peterjc
Copy link

commented Jul 29, 2016

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"
@automaticgiant

This comment has been minimized.

Copy link

commented May 2, 2018

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).

@cortesi

This comment has been minimized.

Copy link
Member

commented Jun 1, 2018

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

This comment has been minimized.

Copy link
Member

commented Jun 3, 2018

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
You can’t perform that action at this time.