Skip to content

Commit 39e3ed8

Browse files
authored
Merge pull request #4168 from rtfd/memory-time-tutorial
Add another guide around fixing memory usage.
2 parents 31e249f + 4f52f6c commit 39e3ed8

File tree

2 files changed

+27
-1
lines changed

2 files changed

+27
-1
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
My Build is Using Too Many Resources
2+
====================================
3+
4+
We limit build resources to make sure that users don't overwhelm our build systems.
5+
If you are running into this issue,
6+
there are a couple fixes that you might try.
7+
8+
.. note:: The current build limits can be found on our :doc:`/builds` page.
9+
10+
Reduce formats you're building
11+
------------------------------
12+
13+
You can change the formats of docs that you're building with our YAML file's :ref:`yaml-config:Formats` option.
14+
15+
In particular, the `htmlzip` takes up a decent amount of memory and time,
16+
so disabling that format might solve your problem.
17+
18+
Reduce documentation build dependencies
19+
---------------------------------------
20+
21+
A lot of projects reuse their requirements file for their documentation builds.
22+
If there are extra packages that you don't need for building docs,
23+
you can create a custom requirements file just for documentation.
24+
This should speed up your documentation builds,
25+
as well as reduce your memory footprint.

package.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66
"dependencies": {
77
"bowser": "^1.9.3",
88
"cssfilter": "0.0.8",
9-
"github-changelog": "git+https://github.com/agjohnson/github-changelog.git"
9+
"github-changelog": "git+https://github.com/agjohnson/github-changelog.git",
10+
"npm": "^6.1.0"
1011
},
1112
"devDependencies": {
1213
"bower": "*",

0 commit comments

Comments
 (0)