-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Docs: Fix build 3 warnings #9809
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
Docs: Fix build 3 warnings #9809
Conversation
… ('-j auto' for parallel builds + fail on Warnings)
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.
This is good! 👍🏼
The next obvious step here is to unpin all the packages from requirements/docs.in
; keeping pinned only the ones that are required to be pinned. This way, our GitHub action auto-updates them weekly following the same pattern we have with the rest of the requirements and we don't have to care about these type of PRs
# All-together, we cannot upgrade to Sphinx 5.x before either sphinx-tabs or sphinx-rtd-theme fixes these | ||
# issues. | ||
sphinx-tabs==3.3.1 |
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.
We can probably migrate sphinx-tabs
to sphinx-design
: https://sphinx-design.readthedocs.io/en/latest/tabs.html at some point
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.
That would be really great. 1) to have one extension less and 2) I got an impression that sphinx-tabs is less maintained nowadays.
I was somehow under the impression that the dev docs were building fine. But they have some broken intersphinx references. I'll fix that as well...
YES 💯 |
These 503 errors were temporary. Has there been a known disturbance or should this be escalated separately?
|
Escalated to where? Those 503 errors on those URLs are from our own service. |
A GitHub issue? |
2 warnings were caused by extensions that didn't declare to be parallel safe.
1 warning was do to a parallel bug in sphinxcontrib-httpdomain that got fixed in 1.8.1.
I also updated the Makefile to run a build that looks more like the Read the Docs build, so the chances to discover these issues locally are a bit higher.