Missing HTML span element in exceptions.html

[vivekvashist]

BPO	46127
Nosy	@devdanzin, @vivekvashist
Files	Screen Shot 2021-12-19 at 5.29.54 pm.png

^{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 2021-12-21.00:33:35.901>
created_at = <Date 2021-12-19.07:07:18.288>
labels = ['invalid', '3.10', 'docs']
title = 'Missing HTML span element in exceptions.html'
updated_at = <Date 2021-12-21.00:33:35.900>
user = 'https://github.com/vivekvashist'

bugs.python.org fields:

activity = <Date 2021-12-21.00:33:35.900>
actor = 'vivekvashist'
assignee = 'docs@python'
closed = True
closed_date = <Date 2021-12-21.00:33:35.901>
closer = 'vivekvashist'
components = ['Documentation']
creation = <Date 2021-12-19.07:07:18.288>
creator = 'vivekvashist'
dependencies = []
files = ['50501']
hgrepos = []
issue_num = 46127
keywords = []
message_count = 3.0
messages = ['408886', '408900', '408938']
nosy_count = 3.0
nosy_names = ['ajaksu2', 'docs@python', 'vivekvashist']
pr_nums = []
priority = 'normal'
resolution = 'not a bug'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue46127'
versions = ['Python 3.10']

[vivekvashist]

Link:
https://docs.python.org/3/library/exceptions.html#exception-hierarchy

Looking at EncodingWarning under exception-hierarchy is displaying BLACK color instead of RED.

Digging into HTML looks like it is missing the appropriate span class element.

Working:

<span class="o">+--</span> <span class="ne">BytesWarning</span>

Broken:

<span class="o">+--</span> <span class="n">EncodingWarning</span>

See attached screenshot.

I"m not too familiar with Sphinx but I'm happy to create a PR for this issue if someone could point me in right direction on how to fix this.

[devdanzin]

That happens because EncodingWarning isn't highlighted as an Exception by Pygments[0]. The doc page gets its exceptions diagram by:
".. literalinclude:: ../../Lib/test/exception_hierarchy.txt"
and all other entries are recognized by Pygments, so we get the "ne" class for them.

A PR for Pygments adding EncodingWarning could be interesting, but I'm not sure the doc build process would pick it up and fix the 3.10 docs issue.

For 3.11, the diagram drawing was changed so no highlighting happens anymore, which fixes the issue for us in the long run.

[0] https://github.com/pygments/pygments/blob/8630e033313647d9579e314f3e8e2882f4558933/pygments/lexers/python.py#L225

[vivekvashist]

Thanks for the information Daniel.