Skip to content

Commit 7cd3df4

Browse files
authored
Merge pull request #6778 from readthedocs/humitos/too-resources-docs
Update guide about building consuming too much resources
2 parents 7de9836 + c803115 commit 7cd3df4

File tree

1 file changed

+6
-9
lines changed

1 file changed

+6
-9
lines changed

docs/guides/build-using-too-many-resources.rst

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -41,17 +41,14 @@ when using multiple channels.
4141
That is, to build the documentation is probably that you need fewer Python packages than to use your library itself.
4242
So, in this case, you could use ``pip`` to install those fewer packages instead of creating a big environment with ``conda``.
4343

44+
Document Python modules API statically
45+
--------------------------------------
4446

45-
Use system site-packages for pre-installed libs
46-
-----------------------------------------------
47+
If you are installing a lot of Python dependencies just to document your Python modules API using ``sphinx.ext.autodoc``,
48+
you can give a try to `sphinx-autoapi`_ Sphinx's extension instead which should produce the exact same output but running statically.
49+
This could drastically reduce the memory and bandwidth required to build your docs.
4750

48-
There are a few libraries that Read the Docs has already installed (scipy, numpy, matplotlib, pandas, etc)
49-
in the Docker image used to build your docs. You can check the updated list of pre-installed libraries in the `Docker image repository`_.
50-
51-
To use these pre-installed libraries and avoid consuming time re-downloading/compiling them,
52-
you can use the :ref:`config-file/v2:python.system_packages` option to have access to them.
53-
54-
.. _Docker image repository: https://github.com/readthedocs/readthedocs-docker-images
51+
.. _sphinx-autoapi: https://sphinx-autoapi.readthedocs.io/
5552

5653
Requests more resources
5754
-----------------------

0 commit comments

Comments
 (0)