Support keywords (like returns, example,etc)

[somenxavier]

Like sphinx, can you provide keywords like returns or example to document such things?

Thanks a lot,

[BurntSushi]

Absolutely not. The whole point of using Markdown was to encourage writing documentation using prose rather than be burdened with the mental overhead of remembering annotations.

(Not everyone agrees with this, and that's OK, but for better or worse, than is the trade off made by pdoc. See: https://github.com/BurntSushi/pdoc#motivation)

[somenxavier]

Ok. But how do you refer to a Class of your module? With a link?

[BurntSushi]

Yup. See the docs "Linking to other identifiers": http://pdoc.burntsushi.net/pdoc

[somenxavier]

Thanks for references. What about external references like python json module?

[BurntSushi]

@somenxavier Create a hyperlink.