Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Problem: Travis doesn't run linkcheck on documentation #708

Closed
sallain opened this issue May 24, 2019 · 2 comments
Closed

Problem: Travis doesn't run linkcheck on documentation #708

sallain opened this issue May 24, 2019 · 2 comments
Labels
Type: documentation The issue requires documentation.

Comments

@sallain
Copy link
Member

sallain commented May 24, 2019

Please describe the problem you'd like to be solved.
Sphinx has a nice little feature called linkcheck that will test out all the external links in the documentation and spit out a report of all the errors. It's helpful, but requires users to remember to run it manually.

Describe the solution you'd like to see implemented.
Include linkcheck as part of the standard Travis CI build for documentation.

Linkcheck is pretty heavy-handed so the fail conditions would need to be considered; we use some dummy links that get caught, for example. As per @ross-spencer's comment in #630, it's possible to create exclusion regex patterns to ignore certain links: http://www.sphinx-doc.org/en/1.2/config.html#confval-linkcheck_ignore.

See also this PR for more examples where valid links get caught by linkcheck: artefactual/archivematica-docs#275

Describe alternatives you've considered.

Additional context
Originally filed by @ross-spencer as https://github.com/artefactual/archivematica-docs/issues/169


For Artefactual use:
Please make sure these steps are taken before moving this issue from Review to Verified in Waffle:

  • All PRs related to this issue are properly linked 👍
  • All PRs related to this issue have been merged 👍
  • Test plan for this issue has been implemented and passed 👍
  • Documentation regarding this issue has been written and it has been added to the release notes, if needed 👍
@sallain sallain added Type: documentation The issue requires documentation. Severity: low An inconvenient situation where the software is usable but could be better. and removed Severity: low An inconvenient situation where the software is usable but could be better. labels May 24, 2019
@eviau-artefactual
Copy link

I believe that linkcheck is not available as a pre-commit... but I tried adding it to the tests here: artefactual/archivematica-docs#433

@eviau-artefactual
Copy link

The linkcheck was implemented in artefactual/archivematica-docs#439

It should work starting for versions 1.15 and up.

Thank you for filing this issue ✨

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: documentation The issue requires documentation.
Projects
None yet
Development

No branches or pull requests

2 participants