vanilla icon indicating copy to clipboard operation
vanilla copied to clipboard

Wrong quotes in sphinx documentation

Open arialcrime opened this issue 3 years ago • 3 comments

Even though the correct kind of (straight) quotes are used in the docstrings, the rendered documentation changes them to “typographic” ones. This makes copying from the documentation a bit more tedious than it has to be.

arialcrime avatar Sep 29 '22 13:09 arialcrime

Perhaps backticks should be used in the doc string:

*`"should close"`*

justvanrossum avatar Sep 29 '22 13:09 justvanrossum

That sounds extensive. Maybe explicitly setting this to False already solves it? https://github.com/robotools/vanilla/blob/873d9832da66fc085591beea4f04c998b4dd04c1/Documentation/source/conf.py#L130-L132

arialcrime avatar Sep 29 '22 13:09 arialcrime

Generally we need to mark code fragments as "code", and I would say the smarty pants behavior is desirable for non-code.

justvanrossum avatar Sep 29 '22 13:09 justvanrossum