{"id":37678129,"url":"https://github.com/buildthedocs/btd","last_synced_at":"2026-01-16T12:19:34.176Z","repository":{"id":41362593,"uuid":"115461149","full_name":"buildthedocs/btd","owner":"buildthedocs","description":"A multi-version Sphinx building tool based on containers","archived":false,"fork":false,"pushed_at":"2026-01-02T01:01:28.000Z","size":3221,"stargazers_count":13,"open_issues_count":7,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-01-07T14:42:01.380Z","etag":null,"topics":["container","docker","documentation","sphinx","static-site-generation"],"latest_commit_sha":null,"homepage":"https://buildthedocs.github.io/btd/","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/buildthedocs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","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}},"created_at":"2017-12-26T23:06:33.000Z","updated_at":"2025-03-15T10:16:31.000Z","dependencies_parsed_at":"2025-12-19T10:01:52.675Z","dependency_job_id":null,"html_url":"https://github.com/buildthedocs/btd","commit_stats":{"total_commits":72,"total_committers":3,"mean_commits":24.0,"dds":0.02777777777777779,"last_synced_commit":"67180e0ca49e3619f2475686946997cb4a478bc1"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/buildthedocs/btd","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/buildthedocs%2Fbtd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/buildthedocs%2Fbtd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/buildthedocs%2Fbtd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/buildthedocs%2Fbtd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/buildthedocs","download_url":"https://codeload.github.com/buildthedocs/btd/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/buildthedocs%2Fbtd/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28478551,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-16T11:59:17.896Z","status":"ssl_error","status_checked_at":"2026-01-16T11:55:55.838Z","response_time":107,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["container","docker","documentation","sphinx","static-site-generation"],"created_at":"2026-01-16T12:19:33.561Z","updated_at":"2026-01-16T12:19:34.171Z","avatar_url":"https://github.com/buildthedocs.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003c!--\n  --\u003e\n  \u003ca title=\"Site\" href=\"https://buildthedocs.github.io/btd\"\u003e\u003cimg src=\"https://img.shields.io/website.svg?label=buildthedocs.github.io%2Fbtd\u0026longCache=true\u0026style=flat-square\u0026url=http%3A%2F%2Fbuildthedocs.github.io%2Fbtd%2Findex.html\u0026logo=GitHub\"\u003e\u003c/a\u003e\u003c!--\n  --\u003e\n  \u003ca title=\"Join the chat at gitter.im/buildthedocs/community\" href=\"https://gitter.im/buildthedocs/community\"\u003e\u003cimg src=\"https://img.shields.io/badge/chat-on%20gitter-4db797.svg?longCache=true\u0026style=flat-square\u0026logo=gitter\u0026logoColor=e8ecef\"\u003e\u003c/a\u003e\u003c!--\n  --\u003e\n  \u003ca title=\"'images' workflow Status\" href=\"https://github.com/buildthedocs/btd/actions/workflows/images.yml\"\u003e\u003cimg alt=\"'images' workflow Status\" src=\"https://img.shields.io/github/actions/workflow/status/buildthedocs/btd/images.yml?branch=main\u0026longCache=true\u0026style=flat-square\u0026logo=Github%20Actions\u0026logoColor=e8ecef\u0026label=imgs\"\u003e\u003c/a\u003e\u003c!--\n  --\u003e\n  \u003ca title=\"'test' workflow Status\" href=\"https://github.com/buildthedocs/btd/actions/workflows/test.yml\"\u003e\u003cimg alt=\"'test' workflow Status\" src=\"https://img.shields.io/github/actions/workflow/status/buildthedocs/btd/test.yml?branch=main\u0026longCache=true\u0026style=flat-square\u0026logo=Github%20Actions\u0026logoColor=e8ecef\u0026label=test\"\u003e\u003c/a\u003e\u003c!--\n  --\u003e\n\u003c/p\u003e\n\n# Build The Docs (BTD)\n\nThis is a proof-of-concept to provide a 'lightweight' multi-version documentation generator for users that:\n\n- Rely on a git hosting service to handle users and access permissions.\n- Need to generate/build documentation in different formats (HTML, PDF, EPUB...) and for multiple versions of a project, using [Sphinx](http://www.sphinx-doc.org).\n- Want to be able to generate/build the documentation and have the products optionally deployed to a hosting service automatically.\n\nThe most expected use case is:\n\n- Project hosted on [GitHub](https://github.com).\n- Web site hosted on [GitHub Pages](https://pages.github.com/).\n- A GitHub Actions workflow to build the site after each push.\n\nPossible schemes:\n\n- Save doc sources in:\n  - A subdir of master/development branches.\n  - TODO: The root of a given branch.\n- Deploy to, either the same or a different repository:\n  - Branch `master`.\n  - Branch `gh-pages`.\n  - TODO: Subdir docs in branch `master`.\n\n# Usage\n\nThis project is available as a Python package ([btd](btd)), along with the plumbing to use it as a GitHub Action.\nFind usage guidelines and examples at [buildthedocs.github.io/btd](https://buildthedocs.github.io/btd).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbuildthedocs%2Fbtd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbuildthedocs%2Fbtd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbuildthedocs%2Fbtd/lists"}