-
Notifications
You must be signed in to change notification settings - Fork 547
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
sphinx: remove usage of deprecated notfound-page options #827
sphinx: remove usage of deprecated notfound-page options #827
Conversation
sphinx-notfound-page deprecated and removed notfound_no_urls_prefix, notfound_default_language, and notfound_default_version in favor of notfound_urls_prefix. We were still using these old options which caused our 404 pages to break.
This is a draft on purpose. The 404 pages are still broken, but this at least fixes one of the problems with its configuration. See #678. |
I'd like to merge this for now, as it's needed to matter what we do for #678 (comment). |
👍 for that! |
notfound_default_version = "latest" | ||
# makes default setting explicit: | ||
notfound_no_urls_prefix = False | ||
notfound_urls_prefix = "/ansible/latest/" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One of the related problems we have with the 404 page is #94 (TL;DR; all 404 pages have the /latest/ for left-hand navigation). I'm wondering if we update this value to match the branch, it would fix that older problem? I'm thinking this line goes to "ansible/devel/" in devel, and the stable-2.16 version goes to latest? No impact on this PR but wondering if you think that would work.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, that should be adjusted per branch. I'm not sure what's the best way to do this (without having to do it manually all the time)...
@gotmax23 I'm not sure, but why should this not be backported? IMO it should be backported to all stable branches. |
I marked it as |
I think it's better to backport changes instead of manually replicating them in different stable branches, if backporting is possible. This makes it a lot clearer to readers of the commit log that these changes are coming from |
sphinx-notfound-page deprecated and removed notfound_no_urls_prefix, notfound_default_language, and notfound_default_version in favor of notfound_urls_prefix. We were still using these old options which caused our 404 pages to break. (cherry picked from commit 89ef0d9)
sphinx-notfound-page deprecated and removed notfound_no_urls_prefix, notfound_default_language, and notfound_default_version in favor of notfound_urls_prefix.
We were still using these old options which caused our 404 pages to break.
Relates: #678