Generate documentation before running link check #78
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
umbynos
approved these changes
Jul 2, 2021
Some links may point to the generated documentation content, which would result in a failure of the link check. It's true that these links are indeed broken when accessed outside the website, but the primary publishing location for this content is the website. The alternative would be checking the generated content into the repository, but this would either require some fairly complex automation or else a burden on the contributors to keep it synced.
It's important to use relative links so that the user's website version selection is retained.
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.
Some links may point to the generated documentation content, which would result in a failure of the link check.
It's true that these links are indeed broken when accessed outside the website, but the primary publishing location for
this content is the website. The alternative would be checking the generated content into the repository, but this would
either require some fairly complex automation or else a burden on the contributors to keep it synced.