-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Add another guide around fixing memory usage. #4168
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.
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
Merged
Merged
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Love the new |
||
|
||
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 hidden or 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We use title-case for h1 headers https://docs.readthedocs.io/en/latest/docs.html#titles