fix: prevent documentation site API links from routing to 404 pages #1606
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.
Description
This fix adds a
_config.yml
file to thewebsite/build
folder so that github pages will load files with an underscore prefix. Also changes when 'API Reference' links are added toreadme.md
files to prevent them from linking to api documentation that wasn't built.Motivation & context
Fix #1544
Github pages wouldn't recognize the documentation site api files because they had an underscore prefix, a
.nojekyll
or_config.yml
file needed to be added to the sites root folder for them to be recognized. More info on can be found here.'API Reference' links would be added to package readme.md documentation files even if the api documentation didn't build correctly. This would lead to a 404 error, since the link wasn't linking to anything in these cases.
Issue type checklist
Is this a breaking change?
Process & policy checklist