readthedocs / recommonmark

A markdown parser for docutils
https://recommonmark.readthedocs.io/
MIT License
340 stars 252 forks source link

Linking to autodoc methods with recommonmark #173

Closed benwhalley closed 2 years ago

benwhalley commented 5 years ago

The docs explain the use of eval_rst fenced blocks, but I'm not clear how to do the equivalent of

This is markdown text talking about `:class:`MyClass` within a sentence.

within a markdown document to link to an autodoc generated page. If this (i.e. inline rst) isn't possible then it might be worth being explicit about that in the docs.