Update guide about building consuming too much resources #6778
Conversation
This file contains 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
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.
|
Mocking libs could also works I think https://github.com/readthedocs/readthedocs.org/blob/master/docs/faq.rst#i-get-import-errors-on-libraries-that-depend-on-c-modules |
davidfischer
approved these changes
Mar 25, 2020
I do favor removing notes about using the system site-packages. However, mocking libs as @stsewd notes might also be worth a mention.
|
OK. I merging this PR for now. We can add the mocking section in another PR. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR,
torch,tensorflow, etc. See #6742sphinx-autoapithat we have been recommending it on many different issues already, and it makes sense just to have it documented there as well