{"id":20355951,"url":"https://github.com/hedzr/sphinx-study","last_synced_at":"2026-06-01T06:31:05.143Z","repository":{"id":47589659,"uuid":"516198674","full_name":"hedzr/sphinx-study","owner":"hedzr","description":"a notebook for studying sphinx documenter","archived":false,"fork":false,"pushed_at":"2023-05-16T04:08:11.000Z","size":5974,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-04T17:41:13.921Z","etag":null,"topics":["sphinx-doc","sphinx-docs","sphinx-documentation"],"latest_commit_sha":null,"homepage":"https://hz-sphinx-study.readthedocs.io/","language":"JavaScript","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/hedzr.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}},"created_at":"2022-07-21T02:33:19.000Z","updated_at":"2022-08-10T23:29:20.000Z","dependencies_parsed_at":"2024-02-16T04:44:49.567Z","dependency_job_id":null,"html_url":"https://github.com/hedzr/sphinx-study","commit_stats":null,"previous_names":[],"tags_count":4,"template":true,"template_full_name":null,"purl":"pkg:github/hedzr/sphinx-study","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hedzr%2Fsphinx-study","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hedzr%2Fsphinx-study/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hedzr%2Fsphinx-study/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hedzr%2Fsphinx-study/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hedzr","download_url":"https://codeload.github.com/hedzr/sphinx-study/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hedzr%2Fsphinx-study/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33763648,"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-01T02:00:06.963Z","response_time":115,"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":["sphinx-doc","sphinx-docs","sphinx-documentation"],"created_at":"2024-11-14T23:14:34.542Z","updated_at":"2026-06-01T06:31:05.125Z","avatar_url":"https://github.com/hedzr.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# sphinx study\n\n[Latest ![Documentation Status](https://readthedocs.org/projects/hz-sphinx-study/badge/?version=latest)](https://hz-sphinx-study.readthedocs.io/en/latest/?badge=latest)\n[Stable ![Documentation Status](https://readthedocs.org/projects/hz-sphinx-study/badge/?version=stable)](https://hz-sphinx-study.readthedocs.io/en/stable/?badge=stable)\n\na notebook for studying sphinx documenter.\n\nThis repo is a expeiremental notebook for studying how to use sphinx to build a online docsite.\n\n[status admin](https://readthedocs.org/projects/hz-sphinx-study/)\n\n## Build\n\nThe following command will install the packages according to the configuration file requirements.txt.\n\ninstall\n\n```bash\npip install -r requirements.txt\n```\n\nfreeze\n\n```bash\npip freeze \u003e requirements.txt\n```\n\nlist\n\n```bash\npip list\n```\n\n\n## How to Create Python Requirements File After Development\n\nWhile it is possible to create it manually, it is a good practice to use the pipreqs module. It is used to scan your imports and build a Python requirements file for you.\n\nAccording to [THE DOCUMENTATION](https://github.com/bndr/pipreqs), once installed with the following command:\n\n```bash\npip install pipreqs\n```\n\nrunning pipreqs in the command line generates a `requirements.txt` file automatically:\n\n```bash\n$ pipreqs /home/project/location\nSuccessfully saved requirements file in   /home/project/location/requirements.txt\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhedzr%2Fsphinx-study","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhedzr%2Fsphinx-study","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhedzr%2Fsphinx-study/lists"}