Skip to content
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

Update guide about building consuming too much resources #6778

Merged
merged 2 commits into from Mar 26, 2020

Conversation

humitos
Copy link
Member

@humitos humitos commented Mar 13, 2020

This PR,

  • removes the mention about system site-packages because we don't really support them
    • it's impossible to know what versions are installed in the images
    • those packages do not generate any problem related to build resources
    • if we want to go in that direction, we may want to install torch, tensorflow, etc. See #6742
  • add a new section about sphinx-autoapi that we have been recommending it on many different issues already, and it makes sense just to have it documented there as well

humitos added 2 commits Mar 13, 2020
We don't really support these libraries. It's not possible to know
which versions are installed and, the libraries currently installed in
the images by default are not a problem in our builds.

If we want to go in this direction, we should add problematic
libraries (like `torch`, `tensorflow`, etc) and document what versions
are in the docker images.
Let users known about sphinx-autoapi and ask them to try it out before
requesting more resources.
@humitos humitos requested a review from Mar 13, 2020
@stsewd
Copy link
Member

@stsewd stsewd commented Mar 16, 2020

Copy link
Contributor

@davidfischer davidfischer left a comment

I do favor removing notes about using the system site-packages. However, mocking libs as @stsewd notes might also be worth a mention.

@humitos
Copy link
Member Author

@humitos humitos commented Mar 26, 2020

OK. I merging this PR for now. We can add the mocking section in another PR.

@humitos humitos merged commit 7cd3df4 into master Mar 26, 2020
3 checks passed
@humitos humitos deleted the humitos/too-resources-docs branch Mar 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants