-
Notifications
You must be signed in to change notification settings - Fork 657
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
Clone the contrib repo for every docs dependency install to fix docs build #1464
Clone the contrib repo for every docs dependency install to fix docs build #1464
Conversation
e59d1ba
to
85995c6
Compare
An ALTERNATIVE more long-term solution to this is #1465 |
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 is a good step forward, thanks @NathanielRN 👍
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.
LGTM, but I don't think this closes #1352. That seems to be an issue with git tags and RTD not picking up the changes to stable.
Lets remove the "fixes" and see if it actually fixes after
@aabmass Sounds good! I have removed 👍 |
Description
In the linked issue, it was pointed out that the readTheDocs build is failing with the following error message:
I've seen this error before and hope that this PR has the solution 😄
Related to: #1352
Solution Explanation
Initially I was hoping to take advantage of
pip
's --src or --target options to have the repo cloned to the directory I wanted (i.e../opentelemtry-python-contrib
) but pip does not allow certain options in its requirements.txt file 😕Next, I read how the readTheDocs configuration file works.
readTheDocs
supports using conda enviornment variables but new versions of Conda have an issue that means environment variables are not passed to pip correctly so we again can't do--src
So no luck on readTheDocs.
If we knew the path to the virtual env then we could expect the first
-e
install and clone the repo at the path<venv_path>/src
as in the docs but the build says the venv name ispython3.8 -mvirtualenv /home/docs/checkouts/readthedocs.org/user_builds/opentelemetry-python/envs/latest
so I don't know what would happen if it went to.... /stable
😕Finally I decided to just go with cloning the repo every time for these packages. The Contrib repo is 40MB large, and there is a 3GB limit for readTheDocs. We should be fine to merge this, but I think a good follow up would be to remove all the references in docs that need these Contrib packages 😄
But if we merge this at least the build will be fixed 😄
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
I wasn't able to get a local build of readTheDocs working... but hopefully we can try this first and I'll follow up with additional fixes if needed 😄
Does This PR Require a Contrib Repo Change?
Checklist:
- [ ] Changelogs have been updated- [ ] Unit tests have been added- [ ] Documentation has been updated