-
Notifications
You must be signed in to change notification settings - Fork 16.7k
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
Feature: linkcheck-action #534
Feature: linkcheck-action #534
Conversation
HunterGerlach
commented
Jan 4, 2023
•
edited
Loading
edited
- Add support for local build and linkchecking of docs
- Add GitHub Action to automatically check links before prior to publication
- Minor reformat of Contributing readme
- Fix existing broken links
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes! love this - thank you so much!!!!
@hwchase17 I am running into an issue with the link re-writes. Since they are rewritten from |
5ff8b7b
to
da5076d
Compare
ah yeah i think we need to use :doc: references everywhere. its also better practice in general so i guess this is a good forcing function this is a bit tedious - i can take a stab at it tonight while im watching tv :) |
I don't mind doing it to free you up for other more important tasks if you just want to do a few so I can see an example or two (e.g. |
i think (not 100%, need to spend some time to be sure) that ":doc: |
We'll see... |
629395d
to
eb22c7d
Compare
I was unable to get it to work with I switched to using a dedicated linkchecker instead. I have removed all broken links, so running this from now on should prevent any broken links from getting into |
@HunterGerlach .... i dont think it is an overstatement to call you a hero for this im gonna merge this into a dev branch and build a copy of the docs from that (just to check that the build-the-docs action works as expected with this) |
- Add support for local build and linkchecking of docs - Add GitHub Action to automatically check links before prior to publication - Minor reformat of Contributing readme - Fix existing broken links Co-authored-by: Hunter Gerlach <hunter@huntergerlach.com> Co-authored-by: Hunter Gerlach <HunterGerlach@users.noreply.github.com> Co-authored-by: Hunter Gerlach <hunter@huntergerlach.com>