-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
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
Very slow build time with v3.0.1 #7479
Comments
…3.0.0 following the recommendation here sphinx-doc/sphinx#7420 changed m2r to m2r @ git+https://github.com/crossnox/m2r@dev#egg=m2r sphinx-doc/sphinx#7479
TypeError: add_source_parser() positional arguments error in Sphinx v3.0.0 following recommendation sphinx-doc/sphinx#7420 to change m2r to m2r @ git+https://github.com/crossnox/m2r@dev#egg=m2r sphinx-doc/sphinx#7479
TypeError: add_source_parser() positional arguments error in Sphinx v3.0.0 following recommendation sphinx-doc/sphinx#7420 to change m2r to m2r @ git+https://github.com/crossnox/m2r@dev#egg=m2r sphinx-doc/sphinx#7479
I'm experiencing a similar slowdown on a closed-source project.
Environment
Search for root causeWith all api docs removed except for the following:
When removing So, not a root cause, but at least it's a breadcrumb. edit: I'm also using |
Call ``inspect.unwrap()`` for Mocked objects and modules causes deep recurrsion calls. As a result, it causes slow builds. This skips to try documenting mocked objects on filtering members.
Call ``inspect.unwrap()`` for Mocked objects and modules causes deep recurrsion calls. As a result, it causes slow builds. This skips to try documenting mocked objects on filtering members.
Fix #7479: autodoc: Sphinx builds has been slower since 3.0.0
Call ``inspect.unwrap()`` for Mocked objects and modules causes deep recurrsion calls. As a result, it causes slow builds. This skips to try documenting mocked objects on filtering members.
Fix confirmed working with my project. |
Describe the bug
After upgrading to 3.0.1 (and hotfixing
m2r
bug #7420), the build of the docs takes a very long time (~1500s compared to ~30s on 2.4.4). Most of the time is spent onreading sources
which I generate dynamically withsphinxcontrib.apidoc
. This extension just callssphinx-apidoc
, I have checked that the problem persists if I callsphinx-apidoc
directly to generate sources first and thenmake html
which results in a very slow build.To Reproduce
To build our docs you also need
pandoc
which can be installed via package manager such asconda
or via the OS one.Steps to reproduce the behavior:
Expected behavior
Docs build in a reasonable amount of time.
Your project
https://github.com/SeldonIO/alibi
Screenshots
If applicable, add screenshots to help explain your problem.
Environment info
[
'sphinx.ext.autodoc',
'sphinx.ext.doctest',
'sphinx.ext.intersphinx',
'sphinx.ext.todo',
'sphinx.ext.coverage',
'sphinx.ext.mathjax',
'sphinx.ext.ifconfig',
'sphinx.ext.viewcode',
'sphinx.ext.napoleon',
'sphinx_autodoc_typehints',
'sphinxcontrib.apidoc',
'nbsphinx',
'nbsphinx_link',
'm2r'
]
Additional context
m2r
to use this hotfix to build docs in the first place: TypeError: add_source_parser() positional arguments error in Sphinx v3.0.0 #7420conf.py
: https://github.com/SeldonIO/alibi/blob/master/doc/source/conf.pyThe text was updated successfully, but these errors were encountered: