manics/Sphinx linkcheck and summary
Run the Sphinx linkchecker and summarise the results.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| docs-dir | The directory containing the Sphinx documentation. | yes | docs |
| build-dir | The directory containing the built documentation. | yes | docs/_build |
| sphinx-options | Sphinx linkchecker options. | yes | --color -W --keep-going |
| no-error | Ignore errors in linkcheck | yes | false |
Outputs
| name | description |
|---|---|
| broken-links-count | The number of broken links found. |
| permanent-redirects-count | The number of permanent redirects found. |