Skip to content

Comments

Added GitHub workflow to check for broken links#115

Merged
dalonsoa merged 6 commits intoEnergySystemsModellingLab:develop_imperialfrom
ImperialCollegeLondon:broken_link_checker
May 22, 2023
Merged

Added GitHub workflow to check for broken links#115
dalonsoa merged 6 commits intoEnergySystemsModellingLab:develop_imperialfrom
ImperialCollegeLondon:broken_link_checker

Conversation

@dc2917
Copy link
Contributor

@dc2917 dc2917 commented May 19, 2023

Description

This PR adds a new GitHub workflow to check the links in the MUSE readthedocs.io documentation. This is helpful since URLs often stop working as time goes by - this therefore provides an automated way of monitoring for those and flagging them to be sorted.

Fixes #102

Type of change

Please add a line in the relevant section of
CHANGELOG.md to
document the change (include PR #) - note reverse order of PR #s.

  • New feature (non-breaking change which adds functionality)
  • Optimization (non-breaking, back-end change that speeds up the code)
  • Bug fix (non-breaking change which fixes an issue)
  • Breaking change (whatever its nature)

Key checklist

  • All tests pass: $ python -m pytest
  • The documentation builds and looks OK: $ python setup.py build_sphinx

Further checks

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works

@dc2917 dc2917 closed this May 19, 2023
@dc2917 dc2917 reopened this May 19, 2023
@dc2917 dc2917 changed the base branch from develop to develop_imperial May 19, 2023 13:10
@dalonsoa dalonsoa merged commit 7211c32 into EnergySystemsModellingLab:develop_imperial May 22, 2023
@dalonsoa dalonsoa deleted the broken_link_checker branch May 22, 2023 13:01
@dalonsoa dalonsoa mentioned this pull request May 23, 2023
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add GitHub Action to check broken links in documentation.

2 participants