Add configuration file for Read the Docs#1478
Merged
Merged
Conversation
rahulporuri
approved these changes
Jul 2, 2021
Contributor
rahulporuri
left a comment
rahulporuri
left a comment
There was a problem hiding this comment.
LGTM. The built docs on readthedocs look good to me.
Comment on lines
+9
to
+12
| - method: pip | ||
| path: . | ||
| extra_requirements: | ||
| - docs |
Contributor
There was a problem hiding this comment.
I guess this means python -m pip install .[docs]? It's not clear from the docs page.
Member
Author
There was a problem hiding this comment.
Yep. I think there's an example in the RtD docs that makes this somewhat clear, but you're right that it doesn't seem to be spelled out explicitly.
Member
Author
There was a problem hiding this comment.
For reference, I was looking at the bit just after the text "With the previous settings, Read the Docs will execute the next commands:"
This was referenced Jul 14, 2021
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This PR adds a basic configuration file for Read the Docs. This file was sufficient to get the RtD build passing. See https://traits.readthedocs.io/en/docs-readthedocs-config/ for the documentation built from this branch.