-
-
Notifications
You must be signed in to change notification settings - Fork 18.4k
DOC: Skip creating redirects if docs build fails #26752
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
DOC: Skip creating redirects if docs build fails #26752
Conversation
Codecov Report
@@ Coverage Diff @@
## master #26752 +/- ##
==========================================
- Coverage 91.7% 90.29% -1.42%
==========================================
Files 179 179
Lines 50767 50767
==========================================
- Hits 46555 45839 -716
- Misses 4212 4928 +716
Continue to review full report at Codecov.
|
1 similar comment
Codecov Report
@@ Coverage Diff @@
## master #26752 +/- ##
==========================================
- Coverage 91.7% 90.29% -1.42%
==========================================
Files 179 179
Lines 50767 50767
==========================================
- Hits 46555 45839 -716
- Misses 4212 4928 +716
Continue to review full report at Codecov.
|
Did this error just pop up with a new version of sphinx? |
Yep, the error was fixed in #26727. This PR is just for future failures of the doc build, to not include the misleading redirects error. |
self._open_browser(self.single_doc_html) | ||
else: | ||
self._add_redirects() | ||
if ret_code == 0: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do we already have a good error message to the user if the build fails?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes, we'll have the sphinx error message. In the example in the description, the end of the log will be:
Recursion error:
maximum recursion depth exceeded while calling a Python object
This can happen with very large or deeply nested source files. You can carefully increase the default Python recursion limit of 1000 in conf.py with e.g.:
import sys; sys.setrecursionlimit(1500)
thanks @datapythonista |
When the doc build fails, we still try to create the redirected pages, which fails, and adds to the log a misleading error (it looks in the logs like the problem is not the original error but that something is failing in the redirects).
See for example https://travis-ci.org/pandas-dev/pandas/jobs/542714631:
Here I make the redirects be created only if the doc build succeeded. Also opening the browser if we're building a single page.