{"id":15998785,"url":"https://github.com/manics/action-sphinx-linkcheck-summary","last_synced_at":"2025-07-21T17:31:38.758Z","repository":{"id":186340137,"uuid":"675027408","full_name":"manics/action-sphinx-linkcheck-summary","owner":"manics","description":null,"archived":false,"fork":false,"pushed_at":"2024-08-31T19:06:52.000Z","size":10,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-15T10:11:25.903Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","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/manics.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2023-08-05T14:34:30.000Z","updated_at":"2024-08-26T23:12:04.000Z","dependencies_parsed_at":null,"dependency_job_id":"69c1105c-f0db-49f8-9b1a-50a1cd4f8df5","html_url":"https://github.com/manics/action-sphinx-linkcheck-summary","commit_stats":null,"previous_names":["manics/action-sphinx-linkcheck-summary"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/manics/action-sphinx-linkcheck-summary","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manics%2Faction-sphinx-linkcheck-summary","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manics%2Faction-sphinx-linkcheck-summary/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manics%2Faction-sphinx-linkcheck-summary/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manics%2Faction-sphinx-linkcheck-summary/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/manics","download_url":"https://codeload.github.com/manics/action-sphinx-linkcheck-summary/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manics%2Faction-sphinx-linkcheck-summary/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266342809,"owners_count":23914262,"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-21T11:47:31.412Z","response_time":64,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"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-08T08:22:24.434Z","updated_at":"2025-07-21T17:31:38.727Z","avatar_url":"https://github.com/manics.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GitHub Action: Run Sphinx linkcheck and summarise results\n\n[![GitHub Action badge](https://github.com/manics/action-sphinx-linkcheck-summary/workflows/Test/badge.svg)](https://github.com/manics/action-sphinx-linkcheck-summary/actions)\n\n## Pre-requisites\n\nThe repository must contain a [Sphinx project](https://www.sphinx-doc.org) with a `Makefile` that supports the `linkcheck` target.\nFor example, you can use the `sphinx-quickstart` utility.\n\n## Optional input parameters\n\n- `docs-dir`: The directory containing the Sphinx documentation.\n- `build-dir`: The directory containing the built documentation.\n- `sphinx-options`: Sphinx linkchecker options.\n- `no-error`: Default is to fail if the linkcheck returns a non-zero exit code, set to `false` to disable. Note this may hide other errors.\n\n## Outputs\n\n- `broken-links-count`: The number of broken links.\n- `permanent-redirects-count`: The number of permanent redirects.\n\n## Example\n\n```yaml\nname: Example workflow\n\non:\n  pull_request:\n  push:\n  workflow_dispatch:\n\njobs:\n  test_linkcheck:\n    runs-on: ubuntu-22.04\n    steps:\n      - uses: actions/checkout@v4\n      - uses: actions/setup-python@v5\n        with:\n          python-version: \"3.11\"\n      - run: pip install Sphinx\n      - uses: manics/action-sphinx-linkcheck-summary@main\n        with:\n          docs-dir: docs\n          build-dir: docs/_build\n```\n\n## Development\n\nYou can run the summary script locally:\n\n```sh\n./summarise-linkcheck-output.bash docs/_build/linkcheck/output.json\n```\n\nwhere `docs/_build/linkcheck/output.json` is the output of the Sphinx linkchecker.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmanics%2Faction-sphinx-linkcheck-summary","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmanics%2Faction-sphinx-linkcheck-summary","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmanics%2Faction-sphinx-linkcheck-summary/lists"}