search

NiklasRosenstein / pydoc-markdown

Create Python API documentation in Markdown format.
http://niklasrosenstein.github.io/pydoc-markdown/
Other
458 stars 102 forks source link

pydoc-markdown style undocumented #185

Closed kthy closed 3 years ago

kthy commented 3 years ago

The docs state that pydoc-markdown

Understands multiple doc styles (Sphinx, Google, Pydoc-Markdown)

However, I am unable to find a reference anywhere to what Pydoc-Markdown docstring style looks like. Halp?

NiklasRosenstein commented 3 years ago

Hey @kthy, there's an example in the docs here: https://pydoc-markdown.readthedocs.io/en/latest/docs/api-documentation/processors/#pydocmdprocessor-objects

While looking for it, I found there is a small typo in the example (the railing colon after "Raises" messes up the formatting). Fixed it in d74efe7