Adds readthedocs config yaml #1
Merged
Conversation
This file contains hidden or 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
Lance-Drane
approved these changes
Jun 5, 2024
Collaborator
Lance-Drane
left a comment
Lance-Drane
left a comment
There was a problem hiding this comment.
This LGTM, I don't see anything that needs changing. We don't link to other documentation websites so we should be fine.
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.
Mainly, adding our ReadTheDocs yaml config file to get that setup.
Included:
docs/conf.pyand fail on warnings if we have broken links (I thought that sounded like a good check!)pip install .[doc]command to install the package + our docs requirements (mainlyfurotheme)