Skip to content

Commit

Permalink
Pin urllib3 to v1.x in API docs (#2887)
Browse files Browse the repository at this point in the history
The requests v2.30.0 release introduced support for urllib3 v2, which appears to be breaking for sphinx. This pins the version of urllib3 to a working version until a patch in sphinx. More context in https://github.com/psf/requests/releases/tag/v2.30.0 and urllib3/urllib3#2168.
  • Loading branch information
NSeydoux authored May 9, 2023
1 parent 67b45bc commit 328e3c5
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 5 deletions.
8 changes: 7 additions & 1 deletion packages/browser/docs/api/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,10 @@

pydata-sphinx-theme==0.13.3
myst-parser==1.0.0
Sphinx==6.1.3
# Currently myst-parse is incompatible with sphinx v7
Sphinx==6.2.1
# urllib3 v2.0 only supports OpenSSL 1.1.1+, currently the 'ssl' module is compiled
# with OpenSSL 1.0.2k-fips 26 Jan 2017.
# See: https://github.com/urllib3/urllib3/issues/2168,
# https://github.com/psf/requests/releases/tag/v2.30.0, )
urllib3<2
10 changes: 8 additions & 2 deletions packages/core/docs/api/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# pip install -r requirements.txt

pydata-sphinx-theme==0.13.2
pydata-sphinx-theme==0.13.3
myst-parser==1.0.0
Sphinx==6.1.3
# Currently myst-parse is incompatible with sphinx v7
Sphinx==6.2.1
# urllib3 v2.0 only supports OpenSSL 1.1.1+, currently the 'ssl' module is compiled
# with OpenSSL 1.0.2k-fips 26 Jan 2017.
# See: https://github.com/urllib3/urllib3/issues/2168,
# https://github.com/psf/requests/releases/tag/v2.30.0, )
urllib3<2
10 changes: 8 additions & 2 deletions packages/node/docs/api/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# pip install -r requirements.txt

pydata-sphinx-theme==0.13.2
pydata-sphinx-theme==0.13.3
myst-parser==1.0.0
Sphinx==6.1.3
# Currently myst-parse is incompatible with sphinx v7
Sphinx==6.2.1
# urllib3 v2.0 only supports OpenSSL 1.1.1+, currently the 'ssl' module is compiled
# with OpenSSL 1.0.2k-fips 26 Jan 2017.
# See: https://github.com/urllib3/urllib3/issues/2168,
# https://github.com/psf/requests/releases/tag/v2.30.0, )
urllib3<2

0 comments on commit 328e3c5

Please sign in to comment.