From 49c5665562d5d9cd6d35a3230f1d62e60d60cf67 Mon Sep 17 00:00:00 2001 From: Eric Holscher Date: Wed, 30 May 2018 16:10:30 -0400 Subject: [PATCH 1/3] Add another guide around fixing memory usage. This writes up a simple guide for improving resource usage in your docs. --- .../guides/build-using-too-many-resources.rst | 23 +++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 docs/guides/build-using-too-many-resources.rst diff --git a/docs/guides/build-using-too-many-resources.rst b/docs/guides/build-using-too-many-resources.rst new file mode 100644 index 00000000000..987cc5ffb0a --- /dev/null +++ b/docs/guides/build-using-too-many-resources.rst @@ -0,0 +1,23 @@ +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: + +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. From 93daa7e5b240495efe9c63cd16e21373396740e2 Mon Sep 17 00:00:00 2001 From: Eric Holscher Date: Wed, 30 May 2018 16:11:49 -0400 Subject: [PATCH 2/3] Add note --- docs/guides/build-using-too-many-resources.rst | 4 +++- package.json | 3 ++- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/guides/build-using-too-many-resources.rst b/docs/guides/build-using-too-many-resources.rst index 987cc5ffb0a..a520c71fd25 100644 --- a/docs/guides/build-using-too-many-resources.rst +++ b/docs/guides/build-using-too-many-resources.rst @@ -3,7 +3,9 @@ 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: +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 ------------------------------ diff --git a/package.json b/package.json index 8c3b7cf1141..79d2ffe7afe 100644 --- a/package.json +++ b/package.json @@ -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": "*", From 4f52f6cfaed0d059940674ee9e5e603b967973d6 Mon Sep 17 00:00:00 2001 From: Eric Holscher Date: Wed, 30 May 2018 16:28:01 -0400 Subject: [PATCH 3/3] title case --- docs/guides/build-using-too-many-resources.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/build-using-too-many-resources.rst b/docs/guides/build-using-too-many-resources.rst index a520c71fd25..68e164f3421 100644 --- a/docs/guides/build-using-too-many-resources.rst +++ b/docs/guides/build-using-too-many-resources.rst @@ -1,4 +1,4 @@ -My build is using too many resources +My Build is Using Too Many Resources ==================================== We limit build resources to make sure that users don't overwhelm our build systems.