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

Jump to bottom

Move docs.python.org language and version switcher out of cpython #85200

Closed
JulienPalard opened this issue Jun 18, 2020 · 8 comments
Closed

Move docs.python.org language and version switcher out of cpython #85200

JulienPalard opened this issue Jun 18, 2020 · 8 comments
Assignees
@JulienPalard
Labels
3.7 (EOL) end of life 3.8 only security fixes 3.9 only security fixes 3.10 only security fixes docs Documentation in the Doc dir

Comments

@JulienPalard
Copy link
Member

BPO 41028
Nosy @ned-deily, @ambv, @JulienPalard, @miss-islington
PRs
  • bpo-41028: Doc: Move switchers to docsbuild-scripts. #20969
  • [3.9] bpo-41028: Doc: Move switchers to docsbuild-scripts. (GH-20969) #30343
  • [3.8] bpo-41028: Doc: Move switchers to docsbuild-scripts. (GH-20969) #30344
    		•

    Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields:

    assignee = 'https://github.com/JulienPalard'
closed_at = <Date 2022-02-21.20:52:59.315>
created_at = <Date 2020-06-18.21:35:33.745>
labels = ['3.7', '3.8', '3.9', '3.10', 'docs']
title = 'Move docs.python.org language and version switcher out of cpython'
updated_at = <Date 2022-02-21.20:52:59.315>
user = 'https://github.com/JulienPalard'

    bugs.python.org fields:

    activity = <Date 2022-02-21.20:52:59.315>
actor = 'ned.deily'
assignee = 'mdk'
closed = True
closed_date = <Date 2022-02-21.20:52:59.315>
closer = 'ned.deily'
components = ['Documentation']
creation = <Date 2020-06-18.21:35:33.745>
creator = 'mdk'
dependencies = []
files = []
hgrepos = []
issue_num = 41028
keywords = ['patch']
message_count = 8.0
messages = ['371839', '371865', '380503', '387058', '409536', '409537', '409538', '413438']
nosy_count = 4.0
nosy_names = ['ned.deily', 'lukasz.langa', 'mdk', 'miss-islington']
pr_nums = ['20969', '30343', '30344']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue41028'
versions = ['Python 3.6', 'Python 3.7', 'Python 3.8', 'Python 3.9', 'Python 3.10']
    @JulienPalard
    Copy link
    Member Author

    This is to track 1 from the cpython point of view, mostly just to remove the switchers as they are now handled by docsbuild-scripts.

    see: https://mail.python.org/pipermail/doc-sig/2020-June/004200.html

    @JulienPalard JulienPalard self-assigned this Jun 18, 2020
    @JulienPalard JulienPalard added the docs Documentation in the Doc dir label Jun 18, 2020
    @JulienPalard JulienPalard self-assigned this Jun 18, 2020
    @JulienPalard JulienPalard added the docs Documentation in the Doc dir label Jun 18, 2020
    @JulienPalard
    Copy link
    Member Author

    In production, this is now starting to fix links and picker for the 2.7 version, which was stating:

    Docs by version

    Python 3.9 (in development)

    and now displays:

    Docs by version

    Python 3.10 (in development)

    @JulienPalard
    Copy link
    Member Author

    New changeset ee2549c by Julien Palard in branch 'master':
    bpo-41028: Doc: Move switchers to docsbuild-scripts. (GH-20969)
    ee2549c

    @ned-deily
    Copy link
    Member

    @mdk, This seems to be working great for the the python.org doc builds. What do you think about backporting this to the current active branches so that the doc builds for individual releases and those included with binary installers show the new generic links rather than the out-of-date old links?

    @ned-deily
    Copy link
    Member

    New changeset 811f65b by Ned Deily in branch '3.7':
    bpo-41028: use generic version links in Docs index.
    811f65b

    @ned-deily
    Copy link
    Member

    New changeset b28b022 by Miss Islington (bot) in branch '3.9':
    bpo-41028: Doc: Move switchers to docsbuild-scripts. (GH-20969) (GH-30343)
    b28b022

    @ned-deily
    Copy link
    Member

    I went ahead and auto-backported the full PR to 3.9 and 3.8 since it applies cleanly there and did a manual backport of just the sidebar changes to 3.7 and 3.6 (added in the final merge before EOL). Now just awaiting @ambv approval for 3.8.

    For reference, compare old vs new "Docs by version" sidebar on the index pages:
    https://docs.python.org/release/3.9.9/
    https://docs.python.org/release/3.10.1/

    @ned-deily ned-deily added 3.7 (EOL) end of life 3.8 only security fixes 3.9 only security fixes 3.10 only security fixes labels Jan 2, 2022
    @ambv
    Copy link
    Contributor

    ambv commented Feb 17, 2022

    New changeset 4c48cac by Miss Islington (bot) in branch '3.8':
    bpo-41028: Doc: Move switchers to docsbuild-scripts. (GH-20969) (GH-30344)
    4c48cac

    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees

    @JulienPalard JulienPalard

    Labels
    3.7 (EOL) end of life 3.8 only security fixes 3.9 only security fixes 3.10 only security fixes docs Documentation in the Doc dir
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    3 participants
    @ambv @JulienPalard @ned-deily