-
-
Notifications
You must be signed in to change notification settings - Fork 75
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
have readthedocs install with , drop requirements files #255
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #255 +/- ##
=======================================
Coverage 96.33% 96.33%
=======================================
Files 15 15
Lines 1909 1909
=======================================
Hits 1839 1839
Misses 70 70 ☔ View full report in Codecov by Sentry. |
This is my first time checking out readthedocs config. On the readthedocs page for |
Not that I am aware of.
No, I do not. |
Ok got it. There's Regarding readthedocs installation issues.
My recommended fix is to add I don't know if this is the "best" strategy but it works for |
Ah, I see the doc requirements are included in |
@@ -29,4 +29,4 @@ sphinx: | |||
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html | |||
python: | |||
install: | |||
- requirements: doc/requirements.txt | |||
- pip install ".[all]" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about pip install ".[doc]"
or python -m pip install ".[doc]"
? No need to spend build resources installing numpy
when sphinx should only need the doc building requirements.
Also this line could be indented two spaces I think?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
a) let's allow the assumption that numpy and pytest are installed when building the docs, in case we or anyone else wants to eventually dynamically create content (say, a gallery or jupyter directives).
b) It was not indented before, and I am not 100% sure what rtd expects.
c) It is not that I like rtd even a tiny amount, just trying to get the d*n thing to not fail. I am very much in favor of dropping rtd for GitHub pages.
I’d like to see this run on rtd before merging but I think we would need admin privileges. Better just get this in and see if it works. @newville I’ve missed the etiquette we’ve been following for PRs lately. When would be appropriate for me or someone to merge this in? |
pre-commit run --all-files
with no errorsThis changes the readthedocs config to install uncertainties and dependencies with
pip install ".[all]"
.