GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Let's localize this theme · Issue #194 · python/python-docs-theme

Let's localize this theme #194

New issue
Copy link
New issue
Copy link
Closed
Closed
Let's localize this theme#194
Copy link
Labels
enhancement

Description

@rffontenelle
rffontenelle
opened on Jul 31, 2024
Issue body actions

While Python docs is available for translation, this theme is still used in English. I see strings marked for translation, but there is no localization infra (no message catalog template; no babel's extract, update, compile, etc. commands set; no translation platform) or workflow set.

Is this project accepting contributions for enabling the theme's localization?

Reacted by Adam Turner, Hugo van Kemenade, Maciej Olko, Wulian233 and Stan Ulbrych

Activity

  1. AA-Turner
    added
    enhancement
    on Jul 31, 2024
  2. AA-Turner commented on Jul 31, 2024

    @AA-Turner
    AA-Turner
    on Jul 31, 2024
    Member
    More actions

    Is this project accepting contributions for enabling the theme's localization?

    I think we should.

    Do you have recommendations for what we ought to do?

    A

  3. rffontenelle commented on Jul 31, 2024

    @rffontenelle
    rffontenelle
    on Jul 31, 2024
    ContributorAuthor
    More actions

    Basic steps are:

    • choose a workflow (receive translations and update source messages as a pre-release step during a string freeze, or automatically update source messages and receive translations anytime?)
    • set up a script that runs babel's extract, init, update and compile options (via pybabel or customized Python script that calls babel)
    • optionally set up a translation project in a web-based translation platform like Weblate or Transifex to gather contributions in a more translation-friendly environment (so the translator doesn't have to know how to handle git concepts or GitHub pull requests)

    My 2 cents:

    • host translations in Hosted Weblate (free of charge for free/libre software)
    • have a CI workflow that updates POT file whenever there is a new commit; with webhook set, Weblate will make available new strings for every language
    • have a script for running the babel's commands; this script will be used by the CI workflow, and may be used manually by an maintainer (see Sphinx's babel_runner.py and pydata's noxfile.py).

    By the way, PyPA uses Weblate for warehouse (PyPI) and for Python Packaging User Guide, and it is awesome.

    Reacted by Manuel Kaufmann, Wulian233 and Stan Ulbrych
  4. StanFromIreland commented on Feb 10, 2025

    @StanFromIreland
    StanFromIreland
    on Feb 10, 2025
    Member
    More actions

    Any progress? We have the script but it not receiving much use at the moment. Webplate may take some time to set up but maybe PRs in the meantime? (I don't think its that many strings < 50?)

  5. rffontenelle commented on Feb 10, 2025

    @rffontenelle
    rffontenelle
    on Feb 10, 2025
    ContributorAuthor
    More actions

    My bad. I'll get back to this. Indeed there are not many strings, so it's an easy translation.

  6. StanFromIreland commented on Feb 10, 2025

    @StanFromIreland
    StanFromIreland
    on Feb 10, 2025
    Member
    More actions

    No worries! Webplate/Transifex might just be overkill for this one. All translations have at least one translator that can submit PRs and I'd say this would under take an hour to translate.

  7. m-aciek commented on Feb 10, 2025

    @m-aciek
    m-aciek
    on Feb 10, 2025
    Contributor
    More actions

    My opinion: let's use just PO files in the repository, yet without a platform. And move it to Weblate along the Python docs (in the same project, for better discoverability), when it will be set up (hopefully soon).

    Reacted by Stan Ulbrych and Tomas R.
  8. StanFromIreland commented on Jun 29, 2025

    @StanFromIreland
    StanFromIreland
    on Jun 29, 2025
    Member
    More actions

    When this is implemented, I am happy to write a section for the devguide on contributing here:-)

  9. rffontenelle commented on Aug 8, 2025

    @rffontenelle
    rffontenelle
    on Aug 8, 2025
    ContributorAuthor
    More actions

    For the record, Stan's #246 implements fixes to the localization script from #195.

  10. StanFromIreland
    added this to Translation issues & improvements 🌍on Aug 18, 2025
  11. rffontenelle commented on Sep 3, 2025

    @rffontenelle
    rffontenelle
    on Sep 3, 2025
    ContributorAuthor
    More actions

    Related: python/devguide#1649 by Stan

    Reacted by Stan Ulbrych
  12. StanFromIreland commented on Sep 3, 2025

    @StanFromIreland
    StanFromIreland
    on Sep 3, 2025
    Member
    More actions

    FYI I didn't include your translated po from the PR, it's better it's its own pr.

  13. rffontenelle commented on Sep 3, 2025

    @rffontenelle
    rffontenelle
    on Sep 3, 2025
    ContributorAuthor
    More actions

    It's fine. I'll redo it and create a PR in minutes.

  14. rffontenelle commented on Sep 6, 2025

    @rffontenelle
    rffontenelle
    on Sep 6, 2025
    ContributorAuthor
    More actions

    We're setting python-docs-theme localization in Transifex. Normally one would use Transifex CLI tool to push and pull translations in a CI environment. Instead I'd like to use GitHub integration, which provides seamless integration: send translations to repository whenever they are contributed instead of needing to pull translations from Transifex manually or via CI, optionally set pull requests (or push directly) instead of committing in CI workflow, choose between instantaneous push or a interval before pushing contributions

    But I need a repository owner to install GitHub apps and to allow integration (maybe @AA-Turner ?). See https://help.transifex.com/en/articles/6265125-github-installation-and-configuration

    If not wanted, I can always follow a manual / CI workflow as done in python documentation repositories.

  15. StanFromIreland commented on Sep 6, 2025

    @StanFromIreland
    StanFromIreland
    on Sep 6, 2025
    Member
    More actions

    When I set it up I planned to just open the PR manually, since it takes just under a minute for me. I wouldn’t mind the integration. (FYI it is not a paid feature)

  16. StanFromIreland commented on Sep 9, 2025

    @StanFromIreland
    StanFromIreland
    on Sep 9, 2025
    Member
    More actions

    Happy to close this issue:-)

    Reacted by Hugo van Kemenade
  17. StanFromIreland
    closed this as completedon Sep 9, 2025
  18. github-project-automation
    moved this to Done in Translation issues & improvements 🌍on Sep 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancement

    Projects

    • Translation issues & improvements 🌍
      Status
      Done
      Show more project fields

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

    You are visitor 01402503 — GeezerVison does not store the pages you look up.
    Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.