This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: symbol documentation still exists
Type: Stage: resolved
Components: Documentation Versions: Python 3.10
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: JelleZijlstra, ammar2, docs@python, hauntsaninja, lys.nikolaou, mdk, vstinner
Priority: normal Keywords:

Created on 2021-05-02 03:23 by JelleZijlstra, last changed 2022-04-11 14:59 by admin. This issue is now closed.

Messages (11)
msg392653 - (view) Author: Jelle Zijlstra (JelleZijlstra) * (Python committer) Date: 2021-05-02 03:23
symbol is being removed in 3.10, but https://docs.python.org/3.10/library/symbol.html still exists and claims it will be removed in "future versions". It was removed in bpo-40939 / GH-21005.
msg392655 - (view) Author: Shantanu (hauntsaninja) * Date: 2021-05-02 03:31
Do you see what's generating it? As far as I can tell, the RST was removed a while ago in https://github.com/python/cpython/pull/21624
msg392656 - (view) Author: Jelle Zijlstra (JelleZijlstra) * (Python committer) Date: 2021-05-02 03:41
You're right, the file doesn't exist on master. I guess there must be some sort of caching. For what it's worth, I found it by going to the module documentation on an earlier version and using the dropdown to navigate to 3.10.

If you go to the dataclasses docs and select a version where it doesn't exist yet (e.g., 3.6), it redirects to https://docs.python.org/3.6/. That feels like the right behavior here too.
msg392733 - (view) Author: Ammar Askar (ammar2) * (Python committer) Date: 2021-05-02 21:11
Added Julien to the nosy list, looks like we might be retaining old deleted docs pages.
msg392738 - (view) Author: Julien Palard (mdk) * (Python committer) Date: 2021-05-02 21:32
This is interesting!

Also notice the footer: Last updated on Jul 26, 2020.

I checked on the docsbuild server and found the `symbol.html` file was marked as modified today (probably by the build cron) (and it contains the "Last updated on Jul 26, 2020" string, yes).

I think the explanation may be that Sphinx does not remove a file from the html output when it's rst counterpart is removed (which may be legitimate, Sphinx can't guess the rst was there before, so it can't distinguish if it's a human generated file that should be kept, or an old file to delete).

There's however no links pointing to it (apart when switching version from 3.9 to 3.10 using the version switcher).

I'm removing the files manually as is:

    docsbuild@docs:/srv/docsbuild/3.10$ rm cpython-*/Doc/build/html/library/symbol.html 

I'll let the daily cron update docs.python.org (to ensure it does the job).
msg392814 - (view) Author: Julien Palard (mdk) * (Python committer) Date: 2021-05-03 15:33
After the cron passed, and after purging the HTTP cache, it now 404:

$ curl https://docs.python.org/3.10/library/symbol.html
<html>
<head><title>404 Not Found</title></head>

Thanks for noticing!
msg392819 - (view) Author: Jelle Zijlstra (JelleZijlstra) * (Python committer) Date: 2021-05-03 15:50
Thanks Julien! I noticed two other libraries in the same situation: https://docs.python.org/3.10/library/formatter.html and https://docs.python.org/3.10/library/parser.html. The RST files for both are also gone from master. Could you purge the cache for them too, or would you prefer I open a new issue?
msg392820 - (view) Author: Ammar Askar (ammar2) * (Python committer) Date: 2021-05-03 15:55
Also, would it make sense to do a clean build (with the html output folder wiped) in the build-cron to avoid this happening in the future?
msg393259 - (view) Author: Julien Palard (mdk) * (Python committer) Date: 2021-05-08 14:37
I `rm -fr 3.10` on the doc server yesterday, so it started 3.10 from scratch today and the file were properly removed.
msg412844 - (view) Author: STINNER Victor (vstinner) * (Python committer) Date: 2022-02-08 15:46
I reopen the issue for binhex.

https://docs.python.org/dev/library/binhex.html is still there whereas https://github.com/python/cpython/blob/main/Doc/library/binxhex.rst is gone.
msg412850 - (view) Author: Julien Palard (mdk) * (Python committer) Date: 2022-02-08 17:56
Oh, it's ~unrelated, but thanks for the heads up, I overlooked a Sentry error :D

It's related to: https://github.com/python/docsbuild-scripts/issues/122, let's track it there.

(The visible effects are the same: the full build, reponsible for deleting the file is failing, while the quick (html only, not removing files) build succeed, so the old HTML files are kept if PDF builds are failing...)
History
Date User Action Args
2022-04-11 14:59:45adminsetgithub: 88172
2022-02-08 17:56:52mdksetstatus: open -> closed
resolution: fixed
messages: + msg412850
2022-02-08 15:46:35vstinnersetstatus: closed -> open

nosy: + vstinner
messages: + msg412844

resolution: fixed -> (no value)
2021-05-08 14:37:06mdksetmessages: + msg393259
2021-05-03 15:55:53ammar2setmessages: + msg392820
2021-05-03 15:50:04JelleZijlstrasetmessages: + msg392819
2021-05-03 15:33:45mdksetstatus: open -> closed
resolution: fixed
messages: + msg392814

stage: resolved
2021-05-02 21:32:35mdksetmessages: + msg392738
2021-05-02 21:11:01ammar2setnosy: + mdk, ammar2
messages: + msg392733
2021-05-02 03:41:51JelleZijlstrasetmessages: + msg392656
2021-05-02 03:31:18hauntsaninjasetnosy: + hauntsaninja
messages: + msg392655
2021-05-02 03:23:20JelleZijlstracreate