Skip to content

Document workaround for "RuntimeError: maximum recursion depth exceeded" #2325

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

Closed
wants to merge 1 commit into from
Closed

Document workaround for "RuntimeError: maximum recursion depth exceeded" #2325

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
19 changes: 19 additions & 0 deletions doc/faq.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -267,3 +267,22 @@ The following notes may be helpful if you want to create Texinfo files:
@definfoenclose strong,*,*
@definfoenclose emph,_,_
"""}


Troubleshooting
---------------

``RuntimeError: maximum recursion depth exceeded while pickling an object`` while building docs
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You may run into this error if you have large documents that can't be pickled
within the standard Python limit of 1000 recursive calls. You can increase the
limit by putting the following in your ``conf.py`` file::

# Workaround for sphinx-build recursion limit overflow:
# pickle.dump(doctree, f, pickle.HIGHEST_PROTOCOL)
# RuntimeError: maximum recursion depth exceeded while pickling an object
#
# Python's default allowed recursion depth is 1000.
import sys
sys.setrecursionlimit(2000) # adjust number as needed