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.
The current build limits can be found on our Build Process page.
Reduce formats you’re building¶
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.
Use pip when possible¶
If you don’t need
conda to create your documentation environment,
pip instead since
conda could require too much memory to calculate the dependency tree
when using multiple channels.
Even though your project environment is created with
conda, it may be not necessary for the documentation environment.
That is, to build the documentation is probably that you need fewer Python packages than to use your library itself.
So, in this case, you could use
pip to install those fewer packages instead of creating a big environment with
Document Python modules API statically¶
If you are installing a lot of Python dependencies just to document your Python modules API using
you can give a try to sphinx-autoapi Sphinx’s extension instead which should produce the exact same output but running statically.
This could drastically reduce the memory and bandwidth required to build your docs.