[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 :)

[AlexWaygood]

@JulienPalard @JelleZijlstra, can somebody pin this issue while the docs are rebuilding? We've had 2 duplicates in 10 minutes

[JulienPalard]

@JulienPalard @JelleZijlstra, can somebody pin this issue while the docs are rebuilding? We've had 2 duplicates in 10 minutes

Done, hope it'll help.

[JulienPalard]

I rebuilt all english docs. Rebuilding other docs now.

[AlexWaygood]

I rebuilt all english docs. Rebuilding other docs now.

Thanks @JulienPalard — I can confirm that I no longer see the problem for the 3.10 docs for typing or pickle, either on Opera on my phone or Safari on my iPad.

[jakirkham]

Yep LGTM as well. Should we close or should this remain open?

[AlexWaygood]

Yep LGTM as well. Should we close or should this remain open?

I'd let @JulienPalard make that decision — I think he may be leaving it open until it's confirmed that the other languages are okay as well

[JulienPalard]

I'll close this when all languages and all versions gets fully rebuilt. I fear if we close it now, some other duplicates may appear.

[JulienPalard]

Complete HTML rebuild done, everything should be fixed now. Thanks @jakirkham for the heads up!

[jakirkham]

Thanks Julien! 🙏

[saaketp]

The docs are broken again it seems?
I can see those colors filling the whole page again.
https://docs.python.org/3/library/typing.html
https://docs.python.org/3/library/pickle.html
https://docs.python.org/3/library/string.html

[AlexWaygood]

The docs are broken again it seems? I can see those colors filling the whole page again. https://docs.python.org/3/library/typing.html https://docs.python.org/3/library/pickle.html https://docs.python.org/3/library/string.html

(Cc. @JulienPalard)

[JulienPalard]

Looks like the venv did not get build properly (I though https://github.com/python/docsbuild-scripts/blob/ac1adcb83baf60261f243a74dab1fd4b9fc6bbf7/build_docs.py#L113 would have been enough).

I installed the right docutils version and restarted an html-only build of 3.10, it should be fast to fix at least /3/.

I hope I'll have time to inspect/understand this in more details in a few hours or tomorrow.

[JulienPalard]

I checked, it's fixed on d.p.o but I don't have time to dig right now, please leave the issue open until this is understood.

[Kenny2github]

Seeing this again in the docs for json, csv, threading, pickle, string, hashlib, typing, and probably others.

Looking at the HTML source of typing:

<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The Python runtime does not enforce function and variable type annotations.
They can be used by third party tools such as type checkers, IDEs, linters,
etc.</p>
</aside>

It seems like admonitions are being opened as <div>s but closed as </aside>s. This is causing the <div> to not close and thus wrap the whole page.

Note that these are broken only on 3.10 docs; 3.9 are fine.

[AlexWaygood]

@JelleZijlstra could you possibly pin this issue, since this is happening again? We're getting a ton of duplicates at the moment :(

[hauntsaninja]

Not sure who all have permissions on the docs setup, but I proposed a fix here: python/docsbuild-scripts#133

[AlexWaygood]

@gvanrossum, did you mean to unpin this issue? :) it's still an ongoing problem, and we just got another duplicate filed :(

[bharel]

Was about to file another duplicate. It's hard to find this issue while all others are getting closed, especially when it's old and doesn't show on top of the issue tracker.

[gvanrossum]

@gvanrossum, did you mean to unpin this issue? :) it's still an ongoing problem, and we just got another duplicate filed :(

Sorry, I didn't mean to. I was just confused by what to me appeared to be a random issue linked at the top of some GitHub page. Maybe a pinned issue should be custom-made to have text alerting people to a something? I honestly didn't understand why this issue was important enough to be pinned.

[JulienPalard]

Sorry for the delay, I'm currently having a very limited internet connectivity (and time) so I'm not following closely those issues.

I merged python/docsbuild-scripts#133, I don't know exactly at which version of Sphinx the issue has been fixed but it should do, thanks @hauntsaninja (if someone have the time to look at it more closely, it would be appreciated).

I also manually restarted a build of 3.10 (English only, HTML only) to check if everything gets fixed (and it is \o/).

More specifically I ran:

cd /srv/docsbuild/
./venv-with-sphinx-3.4.3/bin/python -m pip install 'docutils<=0.17.1'
/srv/docsbuild/venv/bin/python /srv/docsbuild/scripts/build_docs.py --branch 3.10 --languages en --quick

I'm now running (in a GNU screen):

/srv/docsbuild/venv/bin/python /srv/docsbuild/scripts/build_docs.py --branch 3.10 --quick

for other languages to get fixed, and I'm shutting down my internet connectivity, hoping for the best.