Skip to content
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

Merged

Conversation

gotmax23
Copy link
Collaborator

@gotmax23 gotmax23 commented Nov 14, 2023

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

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.
@gotmax23
Copy link
Collaborator Author

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.

@gotmax23 gotmax23 added the no_backport This PR should not be backported. devel only. label Nov 21, 2023
@gotmax23
Copy link
Collaborator Author

I'd like to merge this for now, as it's needed to matter what we do for #678 (comment).

@felixfontein
Copy link
Collaborator

👍 for that!

@samccann samccann merged commit 89ef0d9 into ansible:devel Nov 22, 2023
7 checks passed
notfound_default_version = "latest"
# makes default setting explicit:
notfound_no_urls_prefix = False
notfound_urls_prefix = "/ansible/latest/"
Copy link
Contributor

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.

Copy link
Collaborator

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)...

@felixfontein
Copy link
Collaborator

@gotmax23 I'm not sure, but why should this not be backported? IMO it should be backported to all stable branches.

@gotmax23
Copy link
Collaborator Author

I marked it as no_backport, as I already included the change in #852. I think it makes sense to combine this and the requirements changes in a single PR, as they work together to fix a single issue.

@felixfontein
Copy link
Collaborator

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 devel and don't introduce a difference.

gotmax23 added a commit to gotmax23/ansible-documentation that referenced this pull request Nov 23, 2023
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)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no_backport This PR should not be backported. devel only.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants