{"id":19042103,"url":"https://github.com/paley777/rtd-github-pages","last_synced_at":"2026-06-19T04:31:36.214Z","repository":{"id":239726290,"uuid":"800378574","full_name":"paley777/rtd-github-pages","owner":"paley777","description":"This repository provides a way to automate the creation of documentation for an application.","archived":false,"fork":false,"pushed_at":"2024-05-21T14:15:26.000Z","size":3083,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-21T22:45:00.450Z","etag":null,"topics":["documentation","readthedocs","sphinx-doc"],"latest_commit_sha":null,"homepage":"https://paley777.github.io/rtd-github-pages/","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/paley777.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-05-14T08:11:20.000Z","updated_at":"2024-05-21T14:14:57.000Z","dependencies_parsed_at":"2024-05-21T15:13:44.235Z","dependency_job_id":null,"html_url":"https://github.com/paley777/rtd-github-pages","commit_stats":null,"previous_names":["paley777/rtd-github-pages"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/paley777/rtd-github-pages","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paley777%2Frtd-github-pages","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paley777%2Frtd-github-pages/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paley777%2Frtd-github-pages/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paley777%2Frtd-github-pages/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/paley777","download_url":"https://codeload.github.com/paley777/rtd-github-pages/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paley777%2Frtd-github-pages/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34517748,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-19T02:00:06.005Z","response_time":61,"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-doc"],"created_at":"2024-11-08T22:34:59.184Z","updated_at":"2026-06-19T04:31:36.171Z","avatar_url":"https://github.com/paley777.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"                          \n\u003ch1 align=\"center\" style=\"font-weight: bold;\"\u003eContinuous Documentation Repository 💻\u003c/h1\u003e\n\n\n\u003cp align=\"center\"\u003eThis repository provides a way to automate the creation of documentation for an application.\u003c/p\u003e\n\n\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://paley777.github.io/rtd-github-pages/\"\u003e📱 Results in this Link!\u003c/a\u003e\n\u003c/p\u003e\n \n\u003ch2 id=\"started\"\u003e🚀 Getting started\u003c/h2\u003e\n\nThe process of automating this documentation creation is:\n1.Autodoc calls the .py file automatically to generate documentation.\n2. Generate documentation (sphinx-docs) automatically when a commit is pushed to the repository.\n3. After being generated automatically, the results of the html documentation build are moved to a new branch called \"gh-pages\".\n4. We have set the branch as a Github Pages so that it can be used to host the documentation.\n5. All the processes above occur repeatedly when there are changes via push commit automatically. Without the need to change rst files.\n\nFiles used:\n1. docs_pages_workflow.yml as a file executed by GitHub Actions.\n2. buildDocs.sh as a script to build documentation and push it to the \"gh-pages\" branch.\n \n\u003ch2 id=\"technologies\"\u003e💻 Technologies\u003c/h2\u003e\n\n- Sphinx Docs\n- Read the Docs\n- GitHub Actions\n- GitHub Pages\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpaley777%2Frtd-github-pages","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpaley777%2Frtd-github-pages","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpaley777%2Frtd-github-pages/lists"}