-
Notifications
You must be signed in to change notification settings - Fork 20
Change Install to pip
in .readthedocs.yaml
#154
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
Conversation
Hmmm it's too bad we're running into limitations building on readthedocs. Ideally we could preview a build of each PR using the same build system that the actual portal site is using. This change would move us farther away from that, since the pip environment won't be identical to the conda-forge environment we're using to build on GitHub. I wonder if there's another approach. For the Foundations site, we don't use Readthedocs at all. Rather, we build the PR on GitHub Actions (using the same build environment as our main build) and then display the rendered site on Netlify. Would the same solution work for the sphinx-based portal site? Would we lose some important functionality that readthedocs provides? I'm not sure. |
That sounds better to me, perhaps we discuss this at the next IWG meeting. Unfortunately this is holding up some content PRs as well #147 and #150 |
That sounds like a good plan to me, maybe we can check in with some other people today before we merge. |
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.
This looks good to me! Thanks for making these changes @jukent
pip
in .eadthedocs.yamlpip
in .readthedocs.yaml
matplotlib | ||
pandas | ||
pyyaml | ||
pre-commit |
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.
Do we actually need precommit for readthedocs?
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.
Good question, I just copied all of the dependencies from the environment.yaml
but maybe if we're having 2 locations for dependencies anyway - they can be different?
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.
Thanks, @jukent!
Our Read the Docs builds are often failing due to excessive memory consumption. According to this Read-the-Docs Doc a recommended work around is to use
pip
instead ofconda
for install whenever possible.Example configuration file documentation
This method seems to only work with a
.txt
file, and fails withERROR: Invalid requirement: . . .
when I use the existing.yaml
. I wonder if there is another way.