Skip to content

docs: add sphinx-autoapi mention to build troubleshooting guide #1

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.

Sign up for GitHub

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

Open
enoshdev wants to merge 1 commit into
base: main
Choose a base branch
from
+10 −0
Open

docs: add sphinx-autoapi mention to build troubleshooting guide #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/user/guides/build-using-too-many-resources.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,3 +54,13 @@ Requests more resources
If you still have problems building your documentation,
we can increase build limits on a per-project basis,
sending an email to support@readthedocs.org providing a good reason why your documentation needs more resources.

Using sphinx-autoapi to avoid installing dependencies
------------------------------------------------------

If your project fails due to memory or timeout issues, consider using
`sphinx-autoapi`_ instead of ``autodoc``. It generates API documentation
by statically analyzing your source code without importing it, which avoids
installation and import overhead entirely.

.. _sphinx-autoapi: https://sphinx-autoapi.readthedocs.io/