Check for dead links in documentation #699
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
To workarround an error to an interanl link referenced directly with its html file name.
|
And you have one dead link to fix ;-) |
cjolowicz
approved these changes
Apr 15, 2021
There was a problem hiding this comment.
Thank you, this is very useful! 💚 And sorry it took ages for me to get around to reviewing this...
This caught quite a few broken links, which I fixed by pushing to your branch. I also added the --keep-going option so we get to see all the broken links in one go.
I'll merge this once the CI passes.
cjolowicz
added
cookiecutter
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The cookiecutter documentation is very complete and is full of external links.
I suggest to add a nox session and a GitHub workflow to check if there is no dead links in the documentation.
According to your feedback we could add it in the template too.