Many links to packaging.python.org broken #1026
Comments
|
Thanks for pointing this out. Is there any indication of when this behavior changed? I don't have access to the RTD settings. I wonder if it has to do with translations, since
CC @webknjaz @meowmeowmeowcat |
|
There were some links posted on Discourse at 16:02 UTC yesterday using the old scheme, so I'd guess it was still working then. I don't know of any way to see when exactly it was changed in RTD. |
|
This is a side-effect of fixing #927 (comment) (TL;DR translations don't work with a "single version mode" enabled). I don't have visibility into the main RTD setup for the English site but I suppose we could collect all the affected documents and manually add redirects for those. This would need to be done by @di or @ewdurbin. I can only provide the list of the URIs to map, it can be scraped via https://webknjaz.github.io/intersphinx-untangled/packaging.python.org/ or via intersphinx directly. |
webknjaz
added
type: task
|
This should be the full list: $ python -m sphinx.ext.intersphinx https://packaging.python.org/en/latest/objects.inv | awk -F': ' '{print$2}' | sed 's/#[^#]\+$//g' | sort -u
contribute/
discussions/
discussions/deploying-python-applications/
discussions/install-requires-vs-requirements/
discussions/pip-vs-easy-install/
discussions/wheel-vs-egg/
genindex/
glossary/
guides/
guides/analyzing-pypi-package-downloads/
guides/creating-and-discovering-plugins/
guides/distributing-packages-using-setuptools/
guides/dropping-older-python-versions/
guides/hosting-your-own-index/
guides/index-mirrors-and-caches/
guides/installing-scientific-packages/
guides/installing-stand-alone-command-line-tools/
guides/installing-using-linux-tools/
guides/installing-using-pip-and-virtual-environments/
guides/making-a-pypi-friendly-readme/
guides/migrating-to-pypi-org/
guides/multi-version-installs/
guides/packaging-binary-extensions/
guides/packaging-namespace-packages/
guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/
guides/single-sourcing-package-version/
guides/supporting-multiple-python-versions/
guides/supporting-windows-using-appveyor/
guides/tool-recommendations/
guides/using-manifest-in/
guides/using-testpypi/
key_projects/
news/
overview/
py-modindex/
search/
specifications/
specifications/binary-distribution-format/
specifications/core-metadata/
specifications/declaring-build-dependencies/
specifications/declaring-project-metadata/
specifications/dependency-specifiers/
specifications/direct-url/
specifications/entry-points/
specifications/platform-compatibility-tags/
specifications/pypirc/
specifications/recording-installed-packages/
specifications/simple-repository-api/
specifications/source-distribution-format/
specifications/version-specifiers/
support/
tutorials/
tutorials/creating-documentation/
tutorials/installing-packages/
tutorials/managing-dependencies/
tutorials/packaging-projects/ |
|
I think that if you add a 'prefix redirect' in RTD with no prefix, any URLs which would 404 would instead be redirected to the equivalent page with |
|
Yeah, I don't remember if it's possible to do for 404 only. Maybe listing just top-level routes would do it: $ python -m sphinx.ext.intersphinx https://packaging.python.org/en/latest/objects.inv | awk -F': ' '{print$2}' | sed 's/#[^#]\+$//g;s#^\(\w\+/\).*#\1#g' | sort -u
contribute/
discussions/
genindex/
glossary/
guides/
key_projects/
news/
overview/
py-modindex/
search/
specifications/
support/
tutorials/ |
|
There's also https://sphinx-notfound-page.rtfd.io that can be used as a last resort. |
|
Looks like Thomas is right and we should be able to get away with a prefix redirect per https://docs.readthedocs.io/en/stable/user-defined-redirects.html#prefix-redirects. |
|
The RTD docs page seems pretty clear that it's 404s only. One bit does say 'for the time being', but if they change that I'd hope they do so in a way that requires opting in (e.g. a new option in the 'redirect types' list). I don't think any of the current options allow mapping one prefix to a configurable different one (e.g. |
|
Added prefix redirect. Does that resolve the issue? |
|
I think this can be closed now but I'll leave it to @takluyver so that we have another confirmation. |
|
Thanks, that seems to work. I checked:
|
|
I think this might still be an issue. Twine's docs build failed on https://packaging.python.org/en/latest/tutorials/distributing-packages/, which seems to be a redirect from https://packaging.python.org/tutorials/distributing-packages/. However, I'm not sure what the right page is; maybe https://packaging.python.org/en/latest/tutorials/packaging-projects/? |
Looks like it should be https://packaging.python.org/en/latest/guides/distributing-packages-using-setuptools/. The old tutorial has been converted into a guide in 2018: #498. You can see the file rename/move in the |
|
Hm. From a previously successful build of Twine's docs, it looks like it was redirecting to https://packaging.python.org/tutorials/packaging-projects/. Of course, Twine's docs can be updated, but I assume there's other use of the old URL on the Internet that is now broken. Can we restore the redirect (and others that might have been similarly lost)? |
|
I don't have visibility into what's configured and I'm not sure if there's a way to see the previous configs. We may just have to live with it as it is now. |
|
@ewdurbin Do you have any insight? Can you see if there are other redirects that were overridden/lost when the prefix redirect was added? |
|
Below are all configured redirects, I'm guessing that the prefix redirect is clobbering some of the existing ones but haven't looked closely into how they interact. Redirects table (outdated)
|
|
@ewdurbin Is it possible to update the |
|
@meowmeowmeowcat I don't think that would resolve the issue that I reported above. I can see that there's a redirect from |
|
https://packaging.python.org/tutorials/distributing-packages/ works for me - I get redirected to https://packaging.python.org/en/latest/tutorials/packaging-projects/ . I don't know if something has changed, or if there's some randomness in the order that the redirects are processed. |
|
doing a little testing on that specific URL now, which is why @takluyver got the expected result. looks like if we change the "page" type redirects to "exact" we can restore these URLs, but I don't have time to script the specifics at this very moment. |
|
Is there any more work planned for this issue? Maybe @ewdurbin? |
|
All existing page redirects have been updated to "exact", the current redirect configuration is now as shown below. Seems that caching might take some time to steady out... but this should resolve existing links being broken
|
|
@ewdurbin Thank you! |
I noticed a broken link from the Warehouse help pages to packaging.python.org, and was going to fix it, when I realised every link from Warehouse to packaging.python.org is broken. As are links here on the issue tracker, and links on Discourse posted up to yesterday.
Specifically, a URL like https://packaging.python.org/specifications/core-metadata/ needs an added
/en/latest/to work again. I'm guessing it used to have the 'single version' checkbox selected on RTD, and no longer does ("Use this with caution, only turn it on if you will never have multiple versions of your docs.")IMO, we should either re-enable that setting ASAP (before people share too many links with the new scheme), or add redirects on RTD so existing links still work.
The text was updated successfully, but these errors were encountered: