{"id":29132221,"url":"https://github.com/beeware/beeware-theme","last_synced_at":"2026-02-03T00:42:19.590Z","repository":{"id":299939963,"uuid":"1004683624","full_name":"beeware/beeware-theme","owner":"beeware","description":"A set of Furo theme extensions to make a Sphinx site have BeeWare site branding.","archived":false,"fork":false,"pushed_at":"2025-06-19T03:36:10.000Z","size":0,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-19T03:36:35.275Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"HTML","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/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},"funding":{"github":["freakboy3742"],"custom":["http://beeware.org/bee/join"]}},"created_at":"2025-06-19T02:52:48.000Z","updated_at":"2025-06-19T03:36:12.000Z","dependencies_parsed_at":"2025-06-19T03:48:10.772Z","dependency_job_id":null,"html_url":"https://github.com/beeware/beeware-theme","commit_stats":null,"previous_names":["beeware/beeware-theme"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/beeware/beeware-theme","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beeware%2Fbeeware-theme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beeware%2Fbeeware-theme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beeware%2Fbeeware-theme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beeware%2Fbeeware-theme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/beeware","download_url":"https://codeload.github.com/beeware/beeware-theme/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/beeware%2Fbeeware-theme/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262725227,"owners_count":23354434,"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":"2025-06-30T06:37:24.243Z","updated_at":"2026-02-03T00:42:19.585Z","avatar_url":"https://github.com/beeware.png","language":"HTML","funding_links":["https://github.com/sponsors/freakboy3742","http://beeware.org/bee/join"],"categories":[],"sub_categories":[],"readme":"# BeeWare Theme Templates\n\n**NOTE: This repository has been archived. It was used by Sphinx builds of BeeWare project documentation that had the shared documentation header (Briefacse 0.3.25, Toga 0.5.2, and Rubicon-ObjC 0.5.2). However, with the move to MkDocs for project documentation (completed October 2025) it is no longer required.**\n\nA collection of template files to override the [Furo Sphinx theme](https://github.com/pradyunsg/furo) with BeeWare header and sidebar branding.\n\n## Usage\n\nThese template files are designed to override the Furo Sphinx theme, and will therefore only work if the Furo theme is enabled. The following is required to enable these theme elements on a BeeWare repository's Read the Docs documentation.\n\n1. Update the `pyproject.toml` `[docs]` extra list to include the following:\n\n```toml\n\"beeware_theme @ git+https://github.com/beeware/beeware-theme\",\n```\n\n2. Add the following to `docs/conf.py`:\n\n```python\nimport beeware_theme\n\n\ntemplates_path = []\nhtml_static_path = []\nhtml_css_files = []\nhtml_context = {}\nhtml_theme_options = {}\n\nbeeware_theme.init(\n    project_name=\"my_project\",\n    templates=templates_path,\n    context=html_context,\n    static=html_static_path,\n    css=html_css_files,\n    theme_options=html_theme_options,\n)\n```\nIn this configuration, ``my_project`` is the GitHub project name. You can put\nany other content in ``template_paths``, ``html_static_path``,\n``html_css_files``, ``html_context`` or ``html_theme_options`` as is required by the\nlocal project.\n\n## Testing\n\nTo test this theme, create a virtual environment, and run:\n```\n(venv) $ pip install -e \".[dev]\"\n(venv) $ tox -e docs-live\n```\n\nThis will serve a test project with the theme applied.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbeeware%2Fbeeware-theme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbeeware%2Fbeeware-theme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbeeware%2Fbeeware-theme/lists"}