[docs] [issue31737] Documentation renders incorrectly

Richard Gibson report at bugs.python.org
Mon Oct 9 13:49:43 EDT 2017


New submission from Richard Gibson <richard.gibson at gmail.com>:

The content at docs.python.org seems to be inserting language-dependent "smart quotes" in code blocks, which mangles backslashes and sequences like `'''`. Observed at https://docs.python.org/3/reference/lexical_analysis.html#string-and-bytes-literals , which renders

  longstring      ::=  “”’” longstringitem* “”’” | ‘”“”’ longstringitem* ‘”“”’

instead of

  longstring      ::=  "'''" longstringitem* "'''" | '"""' longstringitem* '"""'

and

  stringescapeseq ::=  “" <any source character>

instead of

  stringescapeseq ::=  "\" <any source character>

, and looks even worse in other languages:

  longstring      ::=   » »” » longstringitem*  » »” » | “ »«  »” longstringitem* “ »«  »”

  longstring      ::=  「」』」 longstringitem* 「」』」 | 『」「」』 longstringitem* 『」「」』


Running `make html` locally produces the desired output, so whatever's going on appears specific to the public site.

----------
assignee: docs at python
components: Documentation
messages: 303988
nosy: docs at python, gibson042
priority: normal
severity: normal
status: open
title: Documentation renders incorrectly
versions: Python 2.7, Python 3.4, Python 3.5, Python 3.6, Python 3.7

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


More information about the docs mailing list