{"id":16885227,"url":"https://github.com/thclark/pre-commit-sphinx","last_synced_at":"2025-10-06T15:15:03.649Z","repository":{"id":53255101,"uuid":"273436302","full_name":"thclark/pre-commit-sphinx","owner":"thclark","description":"A pre-commit hook that will fail if documentation (eg for readthedocs.io) can't be built using sphinx","archived":false,"fork":false,"pushed_at":"2020-08-13T13:00:21.000Z","size":12,"stargazers_count":3,"open_issues_count":5,"forks_count":15,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-07-06T14:42:24.428Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/thclark.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}},"created_at":"2020-06-19T07:49:26.000Z","updated_at":"2024-05-19T05:58:19.000Z","dependencies_parsed_at":"2022-08-27T06:22:07.613Z","dependency_job_id":null,"html_url":"https://github.com/thclark/pre-commit-sphinx","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/thclark/pre-commit-sphinx","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thclark%2Fpre-commit-sphinx","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thclark%2Fpre-commit-sphinx/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thclark%2Fpre-commit-sphinx/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thclark%2Fpre-commit-sphinx/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thclark","download_url":"https://codeload.github.com/thclark/pre-commit-sphinx/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thclark%2Fpre-commit-sphinx/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278630945,"owners_count":26018852,"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-10-06T02:00:05.630Z","response_time":65,"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":[],"created_at":"2024-10-13T16:34:15.331Z","updated_at":"2025-10-06T15:15:03.624Z","avatar_url":"https://github.com/thclark.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# pre-commit-sphinx\nA pre-commit hook that will fail if documentation (eg for [readthedocs.io](https://www.readthedocs.io)) can't be built using sphinx\n\nUsing [pre-commit](https://pre-commit.com/#new-hooks)\n\n\n## build_docs\n\nBuilds documentation using sphinx, returns PASSED to pre-config if the documentation compiles (even with warnings)\n\nUse in your `.pre-commit-config.yaml` file like:\n```yaml\n  - repo: https://github.com/thclark/pre-commit-sphinx\n    rev: 0.0.1\n    hooks:\n      - id: build-docs\n        args: ['--cache-dir', 'docs/doctrees', '--html-dir', 'docs/html', '--source-dir', 'docs/source']\n        language_version: python3\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthclark%2Fpre-commit-sphinx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthclark%2Fpre-commit-sphinx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthclark%2Fpre-commit-sphinx/lists"}