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.

Sign up for GitHub

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

Jump to bottom

More tips about how to reduce resources usage #4419

Merged
merged 2 commits into from
Aug 22, 2018
Merged

More tips about how to reduce resources usage #4419

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ddb6f19
More tips about how to reduce resources usage
humitos Jul 24, 2018
a74ec85
Expand the docs and fix typos
humitos Aug 13, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions docs/guides/build-using-too-many-resources.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,20 @@ If there are extra packages that you don't need for building docs,
you can create a custom requirements file just for documentation.
This should speed up your documentation builds,
as well as reduce your memory footprint.

Use pip when possible
---------------------

In case you are using `conda` to create your environment,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use double backtips `` (conda and pip)

you could consider using `pip` instead since `conda` could require too much memory to calculate the dependency tree.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like this sentence needs some sort of supporting sentence. Why does conda use more memory than pip? Also, I'd phrase it as "If you don't need conda to create your environment, ..."

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know the exact reason of why this is true, but it behaves like that. Also, there are different issues reported at different repositories about this problem of conda consuming too much memory. An example in the official repo: conda/conda#5003

I agree with you that we need to be more explicit here, but I need to think about how to rewrite it.


Use system site-packages for pre-installed libs
-----------------------------------------------

There are a few libraries that Read the Docs has already installed (scipy, numpy, matplotlib, pandas, etc)
in the Docker image used to build your docs. You can check the updated list of pre-installed libraries in the `Docker image repository`_.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We probably need to document which exact libraries are available. I don't think it's reasonable for people to have to dig through a git repo for this data.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to document this here or in the specific YAML config at #4422 ?

Also, this depends on the Docker Image used itself so, I'm not sure that there is a generic way to document this and keep it updated. That's why I mentioned them generally and points to the repository.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think documenting this in the yaml config makes sense, or maybe on another central doc, because we'll be having multiple versions, and each with the same content about build images.


To use these pre-installed libraries and avoid consuming time re-downloading/compiling them,
you ca use the :ref:`yaml-config:Python-use-system-site-packages` option to have access to them.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ca -> can

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The ref should be yaml-config:python.use_system_site_packages #4422


.. _Docker image repository: https://github.com/rtfd/readthedocs-docker-images