{"id":20011727,"url":"https://github.com/sphinx-doc/sphinx-doc-translations","last_synced_at":"2025-05-04T20:31:18.677Z","repository":{"id":42010125,"uuid":"49302854","full_name":"sphinx-doc/sphinx-doc-translations","owner":"sphinx-doc","description":"Translations for Sphinx's documentation","archived":false,"fork":false,"pushed_at":"2025-05-04T01:14:39.000Z","size":637041,"stargazers_count":26,"open_issues_count":3,"forks_count":17,"subscribers_count":18,"default_branch":"master","last_synced_at":"2025-05-04T02:24:34.705Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sphinx-doc.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2016-01-08T23:41:27.000Z","updated_at":"2025-05-04T01:14:43.000Z","dependencies_parsed_at":"2024-06-27T03:54:45.084Z","dependency_job_id":"53f75b9a-70e5-4c41-88bc-723a3f4f8f2e","html_url":"https://github.com/sphinx-doc/sphinx-doc-translations","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-doc%2Fsphinx-doc-translations","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-doc%2Fsphinx-doc-translations/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-doc%2Fsphinx-doc-translations/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-doc%2Fsphinx-doc-translations/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sphinx-doc","download_url":"https://codeload.github.com/sphinx-doc/sphinx-doc-translations/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252395256,"owners_count":21741001,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T07:27:13.031Z","updated_at":"2025-05-04T20:31:13.667Z","avatar_url":"https://github.com/sphinx-doc.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Sphinx official documentation translations\n==========================================\n\n|main| |test|\n\n.. |main| image:: https://github.com/sphinx-doc/sphinx-doc-translations/actions/workflows/main.yml/badge.svg\n          :target: https://github.com/sphinx-doc/sphinx-doc-translations/actions/workflows/main.yml\n          :alt: Badge for the update status\n\n.. |test| image:: https://github.com/sphinx-doc/sphinx-doc-translations/actions/workflows/test-translations.yml/badge.svg\n          :target: https://github.com/sphinx-doc/sphinx-doc-translations/actions/workflows/test-translations.yml\n          :alt: Badge for the translation tests\n\nThis is a project to provide Sphinx official documentation, hosted on the Read The Docs platform, in multiple languages.\n\nHow the translated documentation projects are setup on RTD\n----------------------------------------------------------\n\nInstructions: https://docs.readthedocs.org/en/latest/localization.html#project-with-multiple-translations\n\nKey points:\n\n* There is a RTD project for each language.\n* Each project needs the correct **Language** setting on the **Settings** page.\n* The parent project needs connections created to each translated project on the **Translations Settings** page.\n\n.. list-table::\n   :header-rows: 1\n\n   * - Build Status\n     - sphinx-doc docs\n     - RTD Project\n   * - .. image:: https://readthedocs.org/projects/sphinx/badge/?version=master\n          :target: https://www.sphinx-doc.org/en/master/?badge=master\n          :alt: Documentation Status\n     - http://www.sphinx-doc.org/en\n     - https://readthedocs.org/projects/sphinx/ (Parent project)\n   * - .. image:: https://readthedocs.org/projects/sphinx-ar/badge/?version=master\n          :target: https://www.sphinx-doc.org/ar/master/?badge=master\n          :alt: Documentation Status\n     - http://www.sphinx-doc.org/ar\n     - https://readthedocs.org/projects/sphinx-ar/\n   * - .. image:: https://readthedocs.org/projects/sphinx-ca-es/badge/?version=master\n          :target: https://www.sphinx-doc.org/ca/master/?badge=master\n          :alt: Documentation Status\n     - http://www.sphinx-doc.org/ca\n     - https://readthedocs.org/projects/sphinx-ca-es/\n   * - .. image:: https://readthedocs.org/projects/sphinx-zh-cn/badge/?version=master\n          :target: https://www.sphinx-doc.org/zh_CN/master/?badge=master\n          :alt: Documentation Status\n     - http://www.sphinx-doc.org/zh-cn\n     - https://readthedocs.org/projects/sphinx-zh-cn/\n   * - .. image:: https://readthedocs.org/projects/sphinx-fr/badge/?version=master\n          :target: https://www.sphinx-doc.org/fr/master/?badge=master\n          :alt: Documentation Status\n     - http://www.sphinx-doc.org/fr\n     - https://readthedocs.org/projects/sphinx-fr/\n   * - .. image:: https://readthedocs.org/projects/sphinx-de/badge/?version=master\n          :target: https://www.sphinx-doc.org/de/master/?badge=master\n          :alt: Documentation Status\n     - http://www.sphinx-doc.org/de\n     - https://readthedocs.org/projects/sphinx-de/\n   * - .. image:: https://readthedocs.org/projects/sphinx-it-it/badge/?version=master\n          :target: https://www.sphinx-doc.org/it/master/?badge=master\n          :alt: Documentation Status\n     - http://www.sphinx-doc.org/it\n     - https://readthedocs.org/projects/sphinx-it-it/\n   * - .. image:: https://readthedocs.org/projects/sphinx-ja/badge/?version=master\n          :target: https://www.sphinx-doc.org/ja/master/?badge=master\n          :alt: Documentation Status\n     - http://www.sphinx-doc.org/ja\n     - https://readthedocs.org/projects/sphinx-ja/\n   * - .. image:: https://readthedocs.org/projects/sphinx-ko/badge/?version=master\n          :target: https://www.sphinx-doc.org/ko/master/?badge=master\n          :alt: Documentation Status\n     - http://www.sphinx-doc.org/ko\n     - https://readthedocs.org/projects/sphinx-ko/\n   * - .. image:: https://readthedocs.org/projects/sphinx-pl-pl/badge/?version=master\n          :target: https://www.sphinx-doc.org/pl/master/?badge=master\n          :alt: Documentation Status\n     - http://www.sphinx-doc.org/pl\n     - https://readthedocs.org/projects/sphinx-pl-pl/\n   * - .. image:: https://readthedocs.org/projects/sphinx-pt-br/badge/?version=master\n          :target: https://www.sphinx-doc.org/pt_BR/master/?badge=master\n          :alt: Documentation Status\n     - http://www.sphinx-doc.org/pt-br\n     - https://readthedocs.org/projects/sphinx-pt-br/\n   * - .. image:: https://readthedocs.org/projects/sphinx-doc-ru/badge/?version=master\n          :target: https://www.sphinx-doc.org/ru/master/?badge=master\n          :alt: Documentation Status\n     - http://www.sphinx-doc.org/ru\n     - https://readthedocs.org/projects/sphinx-doc-ru/\n   * - .. image:: https://readthedocs.org/projects/sphinx-sr/badge/?version=master\n          :target: https://www.sphinx-doc.org/sr/master/?badge=master\n          :alt: Documentation Status\n     - http://www.sphinx-doc.org/sr\n     - https://readthedocs.org/projects/sphinx-sr/\n   * - .. image:: https://readthedocs.org/projects/sphinx-es/badge/?version=master\n          :target: https://www.sphinx-doc.org/es/master/?badge=master\n          :alt: Documentation Status\n     - http://www.sphinx-doc.org/es\n     - https://readthedocs.org/projects/sphinx-es/\n\nHow to add a new language translation\n-------------------------------------\n\n1. Add new language to ``locales/update.sh``:\n\n   .. code-block:: diff\n\n      - LANGS='es ja'\n      + LANGS='es ja pt_BR'\n\n2. Update po files:\n\n   .. code-block::\n\n      sh ./locales/update.sh\n\n4. Commit them\n\n5. Add new project on Read The Docs. For example, for ``pt_BR``:\n\n   https://readthedocs.org/projects/sphinx-pt-br/\n\n   .. note:: If a RTD project name for a translation is already taken, create a unique project name instead.\n      For example, when ``sphinx-ru`` was taken, ``sphinx-doc-ru`` was used instead.\n\n7. Add new translation project to parent project:\n\n   https://readthedocs.org/dashboard/sphinx/translations/\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsphinx-doc%2Fsphinx-doc-translations","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsphinx-doc%2Fsphinx-doc-translations","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsphinx-doc%2Fsphinx-doc-translations/lists"}