{"id":31057371,"url":"https://github.com/beeware/beeware-docs-tools","last_synced_at":"2025-09-15T06:59:31.081Z","repository":{"id":310910511,"uuid":"1035778090","full_name":"beeware/beeware-docs-tools","owner":"beeware","description":"Tools for building BeeWare's documentation with a common theme and translations","archived":false,"fork":false,"pushed_at":"2025-09-05T01:21:40.000Z","size":186,"stargazers_count":0,"open_issues_count":4,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-09-05T03:20:35.296Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/beeware.png","metadata":{"files":{"readme":"README.md","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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":["freakboy3742"],"custom":["https://beeware.org/bee/join"]}},"created_at":"2025-08-11T04:40:56.000Z","updated_at":"2025-09-05T01:21:43.000Z","dependencies_parsed_at":"2025-08-21T01:19:08.053Z","dependency_job_id":"8a8bb3b9-6c99-472a-8b63-ce7977003613","html_url":"https://github.com/beeware/beeware-docs-tools","commit_stats":null,"previous_names":["beeware/beeware-docs-tools"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/beeware/beeware-docs-tools","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beeware%2Fbeeware-docs-tools","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beeware%2Fbeeware-docs-tools/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beeware%2Fbeeware-docs-tools/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beeware%2Fbeeware-docs-tools/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/beeware","download_url":"https://codeload.github.com/beeware/beeware-docs-tools/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beeware%2Fbeeware-docs-tools/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":275219532,"owners_count":25425889,"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","status":"online","status_checked_at":"2025-09-15T02:00:09.272Z","response_time":75,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":"2025-09-15T06:59:28.254Z","updated_at":"2025-09-15T06:59:31.069Z","avatar_url":"https://github.com/beeware.png","language":"Python","funding_links":["https://github.com/sponsors/freakboy3742","https://beeware.org/bee/join"],"categories":[],"sub_categories":[],"readme":"# BeeWare Docs Tools\n\nTools for building BeeWare's documentation with a common theme and translations.\n\n## Adding a new language\n\nWeblate is able to generate a new language, however, adding a new language\nalso requires a few changes to the documentation repository.\n\nOnce a new language is generated, you'll need to add a new\n`mkdocs.\u003clanguage-code\u003e.yml` file and update the `tox.ini` file.\n\nThe following example outlines how you would go about adding German to\nthis repo. The concepts are the same for any language in any of the docs\nrepos.\n\n### The new MkDocs configuration file\n\nThe first thing to do is create a new file named `mkdocs.de.yml` in the\n`docs` directory, with the following content:\n\n```yaml\nINHERIT: config.yml\nsite_name: BeeWare Demo zu Docs Tools\nsite_url: https://tutorial.beeware.org/de\ndocs_dir: de\n\ntheme:\n  language: de\n\nextra:\n  translation_type: machine\n```\n\nHere's what is going on in this file:\n\n* This file inherits the configuration content from `config.yml`.\n* The `site_name` value is translated.\n* The `site_url` value is the project site URL, followed by the language\n  code.\n* The `docs_dir` should be the language code.\n* The `theme: language:` value should be the language code, as specified by the\n  MkDocs Material theme. The list can be found\n  [here](https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/).\n  For most languages, this will be the same as the `docs_dir` language code; but\n  for some (in particular languages with locale variants like `zh_CN`), there are\n  differences.\n* The `extra: translation_type:` should be `machine` until the translation reaches\n  100% for the first time, at which point it should be `human`. It will revert to\n  `machine` from `human` if it regresses to below 90%.\n\n### The update to `tox.ini`\n\nYou'll need to make several changes to this file.\n\nYou'll need to add the following:\n\n* The language code environment flag to the header line which begins `[testenv:docs`,\n  preceded by a `-`, with no spaces included.\n* The language code exclusion to the first command, which begins with `!lint`,\n  preceded by `-!`, with no spaces included.\n* The language code to the end of the second line beginning with `translate :`.\n* The language code to the end of the line beginning with `all :`.\n* A new line at the end that matches the other language-specific lines with the\n  new language code.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbeeware%2Fbeeware-docs-tools","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbeeware%2Fbeeware-docs-tools","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbeeware%2Fbeeware-docs-tools/lists"}