Skip to content

Commit

Permalink
Merge pull request #4168 from rtfd/memory-time-tutorial
Browse files Browse the repository at this point in the history
Add another guide around fixing memory usage.
  • Loading branch information
ericholscher committed May 30, 2018
2 parents 31e249f + 4f52f6c commit 39e3ed8
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 1 deletion.
25 changes: 25 additions & 0 deletions docs/guides/build-using-too-many-resources.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
My Build is Using Too Many Resources
====================================

We limit build resources to make sure that users don't overwhelm our build systems.
If you are running into this issue,
there are a couple fixes that you might try.

.. note:: The current build limits can be found on our :doc:`/builds` page.

Reduce formats you're building
------------------------------

You can change the formats of docs that you're building with our YAML file's :ref:`yaml-config:Formats` option.

In particular, the `htmlzip` takes up a decent amount of memory and time,
so disabling that format might solve your problem.

Reduce documentation build dependencies
---------------------------------------

A lot of projects reuse their requirements file for their documentation builds.
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.
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
"dependencies": {
"bowser": "^1.9.3",
"cssfilter": "0.0.8",
"github-changelog": "git+https://github.com/agjohnson/github-changelog.git"
"github-changelog": "git+https://github.com/agjohnson/github-changelog.git",
"npm": "^6.1.0"
},
"devDependencies": {
"bower": "*",
Expand Down

0 comments on commit 39e3ed8

Please sign in to comment.