Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

sphinx: remove usage of deprecated notfound-page options #827

Merged
merged 1 commit into from
Nov 22, 2023
Merged

sphinx: remove usage of deprecated notfound-page options #827

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 1 addition & 6 deletions docs/docsite/rst/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -334,15 +334,10 @@
# with no 'notfound_template' and no 'notfound_context' set,
# the extension builds 404.rst into a location-agnostic 404 page
#
# default is `en` - using this for the sub-site:
notfound_default_language = "ansible"
# default is `latest`:
# setting explicitly - docsite serves up /ansible/latest/404.html
# so keep this set to `latest` even on the `devel` branch
# then no maintenance is needed when we branch a new stable_x.x
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)...


# Options for LaTeX output
# ------------------------
Expand Down