Skip to content
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

Merged
merged 2 commits into from Dec 14, 2022

Conversation

benjaoming
Copy link
Contributor

@benjaoming benjaoming commented Dec 14, 2022

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.

Copy link
Member

@humitos humitos left a 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

Comment on lines +8 to 10
# 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
Copy link
Member

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

Copy link
Contributor Author

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.

@benjaoming
Copy link
Contributor Author

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...

The next obvious step here is to unpin all the packages from requirements/docs.in;

YES 💯

@benjaoming
Copy link
Contributor Author

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...

These 503 errors were temporary. Has there been a known disturbance or should this be escalated separately?

WARNING: failed to reach any of the inventories with the following issues:
intersphinx inventory 'https://myst-parser.readthedocs.io/en/stable/objects.inv' not fetchable due to <class 'requests.exceptions.HTTPError'>: 503 Server Error: Service Unavailable for url: https://myst-parser.readthedocs.io/en/stable/objects.inv
loading intersphinx inventory from https://docs.readthedocs.io/en/stable/objects.inv...
WARNING: failed to reach any of the inventories with the following issues:
intersphinx inventory 'https://jupyterbook.org/en/stable/objects.inv' not fetchable due to <class 'requests.exceptions.HTTPError'>: 503 Server Error: Service Unavailable for url: https://jupyterbook.org/en/stable/objects.inv
loading intersphinx inventory from https://dev.readthedocs.io/en/latest/objects.inv...
loading intersphinx inventory from https://docs.jupyter.org/en/latest/objects.inv...

@benjaoming benjaoming merged commit 4f93dd8 into readthedocs:main Dec 14, 2022
@benjaoming benjaoming deleted the local-sphinx-warning-failure branch December 14, 2022 15:54
@humitos
Copy link
Member

humitos commented Dec 14, 2022

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.

@benjaoming
Copy link
Contributor Author

Escalated to where?

A GitHub issue?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants