dtcenter/METplus Sphinx Linkcheck
Run the Sphinx linkcheck builder against a METplus component docs tree
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| docs-path | Path to the Sphinx docs directory (containing conf.py) | no | docs |
| requirements-file | Path to a pip requirements file for building the docs | no | docs/requirements.txt |
| python-version | Python version to use | no | 3.12 |
| install-package | If "true", pip install the repository itself (editable) before building docs. Needed for repos whose conf.py imports the package directly (e.g. to read __version__). | no | false |
| fail-on-broken-links | If "true", the action fails when linkcheck reports broken links | no | true |
| upload-artifact | If "true", upload the linkcheck output as a workflow artifact | no | true |
| artifact-name | Name for the uploaded linkcheck artifact | no | linkcheck-output |
Outputs
| name | description |
|---|---|
| broken-links-found | "true" if linkcheck reported any broken links |