[docs] [issue28710] Sphinx incompatible markup in the standard library

Raymond Hettinger report at bugs.python.org
Sun Jun 17 21:39:28 EDT 2018


Raymond Hettinger <raymond.hettinger at gmail.com> added the comment:

This should probably be discussed on python-dev.  In particular, changing from single backticks to double backticks is something that makes Sphinx happy but will uglify the docstrings for all other ways of viewing the docs.

Also, note that most of our docs aren't autogenerated from the docstrings so we've never had any particular need to impose Sphinx markup requirements for docstrings.

----------
nosy: +rhettinger

_______________________________________
Python tracker <report at bugs.python.org>
<https://bugs.python.org/issue28710>
_______________________________________


More information about the docs mailing list