classification
Title: sphinx3 renders diffrently docs.python.org for 3.10
Type: Stage:
Components: Documentation Versions: Python 3.10
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: Mariatta, corona10, docs@python, mdk, vstinner
Priority: normal Keywords: patch

Created on 2020-10-15 11:57 by corona10, last changed 2020-10-17 15:07 by corona10.

Pull Requests
URL Status Linked Edit
PR 22739 open corona10, 2020-10-17 14:38
Messages (5)
msg378677 - (view) Author: Dong-hee Na (corona10) * (Python committer) Date: 2020-10-15 11:57
For example
https://docs.python.org/3.10/c-api/bool.html?highlight=pydict_new#c.PyDict_New

should display 

`Return value: New reference.`

but not, this looks like a regression bug.

other version display `Return value: New reference.` very well.
msg378815 - (view) Author: Dong-hee Na (corona10) * (Python committer) Date: 2020-10-17 14:24
This is the regression bug caused by sphinx==3.2.1
If we roll back the sphinx version(2.4.4), it is okay.
I am investigating what causes this issue.
msg378816 - (view) Author: Dong-hee Na (corona10) * (Python committer) Date: 2020-10-17 14:31
sphinx2
(Pdb) par[0].attributes
{'ids': ['c._PyObject_New'], 'classes': [], 'names': ['c._PyObject_New'], 'dupnames': [], 'backrefs': [], 'first': False}

sphinx3
(Pdb) par[0].attributes
{'ids': ['c._PyObject_New'], 'classes': [], 'names': [], 'dupnames': [], 'backrefs': [], 'is_multiline': True}

We are using the names attribute for annotation.
msg378817 - (view) Author: Dong-hee Na (corona10) * (Python committer) Date: 2020-10-17 14:41
One more regression is that
code background highlight is not applied after sphinx version3

See
https://docs.python.org/3.10/c-api/dict.html#c.PyDict_Next
https://docs.python.org/3.9/c-api/dict.html#c.PyDict_Next
msg378818 - (view) Author: Dong-hee Na (corona10) * (Python committer) Date: 2020-10-17 15:07
Okay this is the theme bug.
https://github.com/python/python-docs-theme/pull/57
History
Date User Action Args
2020-10-17 15:07:40corona10setmessages: + msg378818
2020-10-17 15:07:11xtreaksetnosy: + mdk
2020-10-17 14:43:00corona10settitle: docs.python.org for 3.10 missing the new refererence record. -> sphinx3 renders diffrently docs.python.org for 3.10
2020-10-17 14:42:06corona10setnosy: + Mariatta
2020-10-17 14:41:55corona10setmessages: + msg378817
stage: patch review ->
2020-10-17 14:38:08corona10setkeywords: + patch
stage: patch review
pull_requests: + pull_request21702
2020-10-17 14:31:35corona10setmessages: + msg378816
2020-10-17 14:24:05corona10setmessages: + msg378815
2020-10-15 11:57:21corona10create