sphinx3 renders diffrently docs.python.org for 3.10

[corona10]

BPO	42042
Nosy	@rhettinger, @ambv, @JulienPalard, @Mariatta, @corona10, @pablogsal, @miss-islington
PRs	bpo-42042: Use ids attribute instead of names attribute #22739 [3.8] bpo-42042: Use ids attribute instead of names attribute (GH-22739) #23263 [3.9] bpo-42042: Use ids attribute instead of names attribute (GH-22739) #23265
Files	python-391.html: Update

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2020-12-26.13:58:36.769>
created_at = <Date 2020-10-15.11:57:21.365>
labels = ['3.8', '3.9', '3.10', 'performance', 'release-blocker', 'docs']
title = 'sphinx3 renders diffrently docs.python.org for 3.10'
updated_at = <Date 2020-12-26.13:58:36.768>
user = 'https://github.com/corona10'

bugs.python.org fields:

activity = <Date 2020-12-26.13:58:36.768>
actor = 'corona10'
assignee = 'docs@python'
closed = True
closed_date = <Date 2020-12-26.13:58:36.769>
closer = 'corona10'
components = ['Documentation']
creation = <Date 2020-10-15.11:57:21.365>
creator = 'corona10'
dependencies = []
files = ['49682']
hgrepos = []
issue_num = 42042
keywords = ['patch']
message_count = 16.0
messages = ['378677', '378815', '378816', '378817', '378818', '379967', '379973', '379976', '380896', '380898', '380903', '383318', '383346', '383349', '383352', '383806']
nosy_count = 8.0
nosy_names = ['rhettinger', 'docs@python', 'lukasz.langa', 'mdk', 'Mariatta', 'corona10', 'pablogsal', 'miss-islington']
pr_nums = ['22739', '23263', '23265']
priority = 'release blocker'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'performance'
url = 'https://bugs.python.org/issue42042'
versions = ['Python 3.8', 'Python 3.9', 'Python 3.10']

[corona10]

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.

[corona10]

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.

[corona10]

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.

[corona10]

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

[corona10]

Okay this is the theme bug.
python/python-docs-theme#57

[corona10]

@pablogsal

Since this is the developer guide of 3.10.
I would like to suggest as release bloker, if you don't agree you can change it ;)

[pablogsal]

I would like to suggest as release bloker, if you don't agree you can change it ;)

This is indeed a release blocker, but likely for the beta/release candidate phases.

[corona10]

but likely for the beta/release candidate phases.

I think so too

[corona10]

New changeset 09490a1 by Dong-hee Na in branch 'master':
bpo-42042: Use ids attribute instead of names attribute (GH-22739)
09490a1

[miss-islington]

New changeset 5ad468d by Miss Islington (bot) in branch '3.8':
bpo-42042: Use ids attribute instead of names attribute (GH-22739)
5ad468d

[corona10]

New changeset 0f4dd87 by Dong-hee Na in branch '3.9':
[3.9] bpo-42042: Use ids attribute instead of names attribute (GH-22739) (GH-23265)
0f4dd87

[JulienPalard]

Is it fixed?

[corona10]

@mdk

No python/python-docs-theme#57 must be fixed ;)

[rhettinger]

The code background highlights really do need to be restored. Readability has been significantly impaired in 3.10.

[pablogsal]

python/python-docs-theme#57 is landed. We just need a new release of the package to pypi

[corona10]

@pablogsal @rhettinger @mdk @Mariatta

Cool!! everything looks okay!
Now I close this issue.

Thank you to everyone who works on this issue!!