-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4168 from rtfd/memory-time-tutorial
Add another guide around fixing memory usage.
- Loading branch information
Showing
2 changed files
with
27 additions
and
1 deletion.
There are no files selected for viewing
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
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. |
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