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.

Sign up for GitHub

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

Add a language switch to the Python documentation #75228

Closed
JulienPalard opened this issue Jul 26, 2017 · 9 comments
Closed

Add a language switch to the Python documentation #75228

JulienPalard opened this issue Jul 26, 2017 · 9 comments
Labels
3.7 (EOL) end of life docs Documentation in the Doc dir type-feature A feature request or enhancement

Comments

@JulienPalard
Copy link
Member

BPO 31045
Nosy @terryjreedy, @vstinner, @larryhastings, @ned-deily, @methane, @JulienPalard
PRs
  • bpo-31045: Language switch #2652
  • bpo-31045: Language switch (#2652) #3023
  • bpo-31045: Language switch (#2652) #3024
    		•

    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 = None
closed_at = <Date 2017-08-09.11:55:18.442>
created_at = <Date 2017-07-26.14:10:13.986>
labels = ['type-feature', '3.7', 'docs']
title = 'Add a language switch to the Python documentation'
updated_at = <Date 2018-07-02.19:56:30.983>
user = 'https://github.com/JulienPalard'

    bugs.python.org fields:

    activity = <Date 2018-07-02.19:56:30.983>
actor = 'larry'
assignee = 'docs@python'
closed = True
closed_date = <Date 2017-08-09.11:55:18.442>
closer = 'mdk'
components = ['Documentation']
creation = <Date 2017-07-26.14:10:13.986>
creator = 'mdk'
dependencies = []
files = []
hgrepos = []
issue_num = 31045
keywords = []
message_count = 9.0
messages = ['299234', '299447', '299458', '299831', '299910', '299911', '299912', '299931', '320910']
nosy_count = 7.0
nosy_names = ['terry.reedy', 'vstinner', 'larry', 'ned.deily', 'methane', 'docs@python', 'mdk']
pr_nums = ['2652', '3023', '3024']
priority = 'normal'
resolution = None
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue31045'
versions = ['Python 2.7', 'Python 3.6', 'Python 3.7']
    @JulienPalard
    Copy link
    Member Author

    A language switch, like the actual version switch, should allow to change from a translation to another.

    I mean jumping from docs.python.org/3/ to docs.python.org/fr/3/ and so on.

    It's already discussed in PEP-545.

    @terryjreedy
    Copy link
    Member

    I left out 2.7 because I don't know if the 2.7 docs have been or will be included.

    I am looking forward to this because I know someone who programs in Python and is also looking to learn 'professional' Japanese, including CS. I myself might try the Spanish translations, if there are any.

    @terryjreedy terryjreedy added docs Documentation in the Doc dir 3.7 (EOL) end of life labels Jul 29, 2017
    @terryjreedy terryjreedy added the type-feature A feature request or enhancement label Jul 29, 2017
    @JulienPalard
    Copy link
    Member Author

    @terry About Japanese translation, Inada Naoki is the coordinator, their repository is created (https://github.com/python/python-docs-ja) they just have to push now.

    Once this language switch fully tested / implemented / released, it will be easy to add a language. Rules to add a language to the picker are described in PEP-545 (translation have to meet criterias like having a fully translated tutorial).

    Spannish translation exist too, here https://github.com/PyAr/tutorial/commits/master but I don't remember if they contacted us about porting it to docs.python.org.

    FYI I try to document which language is at which step of landing to d.p.o here: https://mdk.fr/blog/python-documentation-translation.html, coordinators are documented here: https://docs.python.org/devguide/experts.html#documentation-translations

    FTR I'm currently testing the new switchers locally, I should be able to remove the "WIP" soon.

    @vstinner
    Copy link
    Member

    vstinner commented Aug 7, 2017

    New changeset dff9b5f by Victor Stinner (Julien) in branch 'master':
    bpo-31045: Language switch (bpo-2652)
    dff9b5f

    @vstinner
    Copy link
    Member

    vstinner commented Aug 8, 2017

    New changeset e93135d by Victor Stinner (Julien Palard) in branch '3.6':
    bpo-31045: Language switch (bpo-2652) (bpo-3023)
    e93135d

    @vstinner
    Copy link
    Member

    vstinner commented Aug 8, 2017

    New changeset 245dafc by Victor Stinner (Julien Palard) in branch '2.7':
    bpo-31045: Language switch (bpo-2652) (bpo-3024)
    245dafc

    @vstinner
    Copy link
    Member

    vstinner commented Aug 8, 2017

    Even if changes are merged, I prefer to wait until the doc at docs.python.org is to date before closing the issue.

    @ned-deily
    Copy link
    Member

    For future reference, please make sure to include current release managers on proposed changes like this since doc building and distribution is part of the release process.

    @larryhastings
    Copy link
    Contributor

    New changeset 1b141b9 by larryhastings (Julien Palard) in branch '3.5':
    Doc: Backport language switcher (bpo-33700, bpo-31045) (bpo-8048)
    1b141b9

    @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
    No one assigned
    Labels
    3.7 (EOL) end of life docs Documentation in the Doc dir type-feature A feature request or enhancement
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    5 participants
    @vstinner @JulienPalard @ned-deily @larryhastings @terryjreedy