{"id":20401934,"url":"https://github.com/jmmanley/readthedocs-sphinx-multiproject-example","last_synced_at":"2025-07-31T02:13:48.348Z","repository":{"id":225435565,"uuid":"765986861","full_name":"jmmanley/readthedocs-sphinx-multiproject-example","owner":"jmmanley","description":"An example of how to use readthedocs with sphinx-multi project","archived":false,"fork":false,"pushed_at":"2024-03-02T14:47:01.000Z","size":2795,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-05T01:43:51.772Z","etag":null,"topics":["documentation","readthedocs","sphinx","sphinx-multiproject"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jmmanley.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2024-03-02T03:09:51.000Z","updated_at":"2024-03-19T14:07:37.000Z","dependencies_parsed_at":null,"dependency_job_id":"d18ddf8d-a303-4ad7-bc75-29ce87702dd7","html_url":"https://github.com/jmmanley/readthedocs-sphinx-multiproject-example","commit_stats":null,"previous_names":["jmmanley/docs-test"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/jmmanley/readthedocs-sphinx-multiproject-example","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmmanley%2Freadthedocs-sphinx-multiproject-example","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmmanley%2Freadthedocs-sphinx-multiproject-example/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmmanley%2Freadthedocs-sphinx-multiproject-example/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmmanley%2Freadthedocs-sphinx-multiproject-example/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jmmanley","download_url":"https://codeload.github.com/jmmanley/readthedocs-sphinx-multiproject-example/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jmmanley%2Freadthedocs-sphinx-multiproject-example/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267977515,"owners_count":24175174,"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-07-31T02:00:08.723Z","response_time":66,"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":["documentation","readthedocs","sphinx","sphinx-multiproject"],"created_at":"2024-11-15T04:52:25.016Z","updated_at":"2025-07-31T02:13:48.331Z","avatar_url":"https://github.com/jmmanley.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"An example of how to use readthedocs with sphinx-multiproject!\nNo guarantee this is optimal, this was just my playground to get things working.\n\n## package1\n[![Documentation Status](https://readthedocs.org/projects/testingoutthedpocs/badge/?version=latest)](https://docs-test-project2.readthedocs.io/projects/package1/en/latest/?badge=latest)\n\n## package2\n\n[![Documentation Status](https://readthedocs.org/projects/docs-test-project2/badge/?version=latest)](https://docs-test-project2.readthedocs.io/en/latest/?badge=latest)\n\nNote: you need a separate readthedocs project for each package.\nEnsure that you specify the `PROJECT` [environmental variable](https://docs.readthedocs.io/en/stable/reference/environment-variables.html) with the name of the desired package to build.\nIf desired, you can add one project as a [subproject](https://docs.readthedocs.io/en/stable/subprojects.html) of another.\nFor example, I set `project1` as a subproject of `project2`.\nTherefore, `project1` is available at both [`testingoutthedpocs.readthedocs.io`](https://testingoutthedpocs.readthedocs.io) and [`docs-test-project2.readthedocs.io/projects/package1/`](https://docs-test-project2.readthedocs.io/projects/package1/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjmmanley%2Freadthedocs-sphinx-multiproject-example","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjmmanley%2Freadthedocs-sphinx-multiproject-example","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjmmanley%2Freadthedocs-sphinx-multiproject-example/lists"}