{"id":16005271,"url":"https://github.com/manics/action-sphinx-linkcheck","last_synced_at":"2025-03-15T10:11:17.011Z","repository":{"id":210693667,"uuid":"727202394","full_name":"manics/action-sphinx-linkcheck","owner":"manics","description":"GitHub Action to run Sphinx Linkcheck and format the results into an easily readable format","archived":false,"fork":false,"pushed_at":"2023-12-04T11:56:10.000Z","size":4,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-22T00:46:43.198Z","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":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/manics.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-12-04T11:50:53.000Z","updated_at":"2023-12-14T13:10:30.000Z","dependencies_parsed_at":null,"dependency_job_id":"5fb3925e-e0cf-4b4b-b1e0-bee20a3d6820","html_url":"https://github.com/manics/action-sphinx-linkcheck","commit_stats":{"total_commits":1,"total_committers":1,"mean_commits":1.0,"dds":0.0,"last_synced_commit":"a0195f95c62e2db2b9c9f3d3b1a6ef286967c7a0"},"previous_names":["manics/action-sphinx-linkcheck"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manics%2Faction-sphinx-linkcheck","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manics%2Faction-sphinx-linkcheck/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manics%2Faction-sphinx-linkcheck/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manics%2Faction-sphinx-linkcheck/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/manics","download_url":"https://codeload.github.com/manics/action-sphinx-linkcheck/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243713415,"owners_count":20335567,"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","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-08T11:03:35.096Z","updated_at":"2025-03-15T10:11:16.984Z","avatar_url":"https://github.com/manics.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GitHub Action: Run Sphinx Linkcheck and format the results\n[![GitHub Action badge](https://github.com/manics/action-sphinx-linkcheck/workflows/test/badge.svg)](https://github.com/manics.action-sphinx-linkcheck/actions)\n\nGitHub Action to run Sphinx Linkcheck and format the results into an easily readable format.\n\nThis action assumes the documentation was setup using\n[`sphinx-quickstart`](https://www.sphinx-doc.org/en/master/usage/quickstart.html)\nand must be run from the directory containing the Sphinx `conf.py` file.\n\n## Optional input parameters\n- `python-version`: Setup this version of Python, default empty (you must setup Python yourself)\n- `requirements-file`: Install the requirements in this file, default empty (you must install requirements including Sphinx yourself)\n- `sphinx-directory`: Directory containing Sphinx `conf.py`, default `.`\n- `sphinx-options`: Value of `SPHINXOPTS`, default `-W --keep-going`\n\n## Example\n\n```yaml\nname: Example workflow\n\non:\n  pull_request:\n  push:\n  workflow_dispatch:\n\njobs:\n  sphinx-docs:\n    runs-on: ubuntu-22.04\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v4\n\n      - name: Run linkcheck and summarise results\n        uses: manics/action-sphinx-linkcheck@main\n        with:\n          python-version: \"3.11\"\n          requirements-file: docs/requirements.txt\n          sphinx-directory: docs\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmanics%2Faction-sphinx-linkcheck","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmanics%2Faction-sphinx-linkcheck","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmanics%2Faction-sphinx-linkcheck/lists"}