Add RTD preview #178
Merged
Add RTD preview #178
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
Collaborator
|
Enabled @ntjohnson1 Can you create an account on RTD so I can add you as a maintainer. We do not have any backup maintainer ATM. |
Collaborator
|
@ntjohnson1 It looks like RTD build failed. Can you take a look at this? |
Collaborator
Author
|
Yes to both. It looks like our RTD is configured to build with python3.7 but our package supports a minimum of 3.8. I should be able to look into where the configuration gets picked up from later this afternoon when I make an account. |
Collaborator
|
I think we need to create a https://docs.readthedocs.io/en/stable/config-file/v2.html#build-tools-python |
* Remove deprecated requirements.txt
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.
For the sake of leaving you lots of PRs for after the long weekend. I think this will improve your quality of life for all the documentation work.
It will require you to enable PR previews https://docs.readthedocs.io/en/latest/pull-requests.html but besides that I think this should be setup. It will build the docs and add a link to ALL PRs. Optionally we could just have that happen for ones that change the docs (see commented block).
The basic config seemed like it satisfied our needs. Once we merge #163 it will also allow for verifying the notebooks run and look nice when we change them.