[DOC] Warnings/notes in docs including most of the page

[jakirkham]

Edit: This was originally notes with the pickle docs, but has also been seen on other pages since. Updating the issue to reflect that.

Not sure if something changed recently with how the docs are being generated, but it appears the warning at the top of the pickle docs is including most of the doc page in the warning. This is picking up all of the APIs and example as a result. Screenshot below:

[JelleZijlstra]

That's nasty. I see it in the 3.9 and 3.10 docs, but not 3.11 or 3.8. pickle.rst hasn't changed on the 3.10 branch since December 2020 (GH-23658), so it's probably not a change to the file. Maybe a Sphinx issue?

[AlexWaygood]

@JulienPalard, any ideas on what might be causing this one? 😕

[saaketp]

It is not just the pickle page.
The string docs are all yellow too https://docs.python.org/3/library/string.html
Only the "see also" box should have been yellow.

Maybe any page with a colored box is getting filled with that color.

edit: found another page that confirms this:
the hashlib docs https://docs.python.org/3.10/library/hashlib.html

[jakirkham]

Thanks for sharing that! Updated the issue to reflect it is broader than its original scope.

[AlexWaygood]

Ugh, the same thing with the typing docs too, now the whole page has a grey background (it should be just the first paragraph).

[jakirkham]

Do the docs build on CI somewhere? Maybe we can diff requirements between the last known working build and the current one to see what may have caused the issue?

[JulienPalard]

Found it.

I introduced the issue while removing and re-creating the build venvs on docs.python.org yesterday after python/psf-salt@ca491a3 to close python/docsbuild-scripts#126.

The new venv got a new version of docutils (we were having 0.17.1, we now have 0.18.1).

Looks like there's some incompatiblity between Sphinx 3.2.1 and docutils 0.18.1, so I'm pinning this version in docsbuild-scripts.

I'll start a rebuild of docs.python.org HTML files in a few minutes and we'll see how it goes.

[JulienPalard]

Looks like it resolved the issue: https://docs.python.org/fr/3.9/library/pickle.html

Rebuilding all languages for all versions may take a few ... hours though :)