search

click-contrib / sphinx-click

A Sphinx plugin to automatically document click-based applications
MIT License
212 stars 57 forks source link

Escape backticks #57

Closed akx closed 4 years ago

akx commented 4 years ago

Backticks embedded in Click documentation trigger a "WARNING: Inline interpreted text or phrase reference start-string without end-string." warning from Docutils, so they need to be escaped.

Original fix by @ruksi – cheers :)

stephenfin commented 4 years ago

I'm not sure about this. What about if someone actually wants to embed actual rST in their docstrings, like here?