Fix docs build #1953
Merged
Fix docs build #1953
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
ADBond
added
bug
RossKen
approved these changes
Feb 12, 2024
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.
Type of PR
Is your Pull Request linked to an existing Issue or Pull Request?
Fixes #1948.
Give a brief description for the solution you have provided
After #1917 the link-checking broke. This appears to be because the file
CONTRIBUTING.mdlives outside thedocs/folder and so is not included in the build. Presumably one of the dependencies I removed did some magic to allow this previously.This adds a symlink in
docs/to the original file, so that tomkdocsit appears in the correct place, and we don't need to worry about keeping both copies in sync. The link rewriting forCONTRIBUTING.mdis already handled from #1913.This dummy PR shows the docs CI passing the link-checking okay now.
PR Checklist