zsol / py.wtf

Autogenerated reference docs for PyPI packages
https://py.wtf
MIT License
10 stars 3 forks source link

Support markdown in documentation #126

Closed zsol closed 2 years ago

zsol commented 2 years ago

Markdown is common in project descriptions. Some md constructs cause docutils parser to raise an exception. The indexer should detect if a documentation string is markdown compatible and process it accordingly (i.e. no need for processing)

zsol commented 2 years ago

Particularly egregious examples:

zsol commented 2 years ago

Fixed in b03878aaba443a90db203bbf1b97dcaf44f5f9d5 and then aabada5eaecdc40161450bb9087ac975ed174183 for images.