Skip to content

Commit f97b885

Browse files
docs(backport): Update docs build requirements (#2281)
* Backport components of: - PR #2252 - PR #2255 - PR #2267 - PR #2271 - PR #2272 - PR #2276
1 parent b3c5ead commit f97b885

File tree

7 files changed

+17
-8
lines changed

7 files changed

+17
-8
lines changed

.readthedocs.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,3 @@ python:
2828
path: .
2929
extra_requirements:
3030
- docs
31-
system_packages: true

README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -372,7 +372,7 @@ and grant `OAC-1450377 <https://www.nsf.gov/awardsearch/showAward?AWD_ID=1450377
372372
.. |Jupyter Book tutorial| image:: https://jupyterbook.org/_images/badge.svg
373373
:target: https://pyhf.github.io/pyhf-tutorial/
374374
.. |Binder| image:: https://mybinder.org/badge_logo.svg
375-
:target: https://mybinder.org/v2/gh/scikit-hep/pyhf/main?filepath=docs%2Fexamples%2Fnotebooks%2Fbinderexample%2FStatisticalAnalysis.ipynb
375+
:target: https://mybinder.org/v2/gh/scikit-hep/pyhf/main?labpath=docs%2Fexamples%2Fnotebooks%2Fbinderexample%2FStatisticalAnalysis.ipynb
376376
377377
.. |PyPI version| image:: https://badge.fury.io/py/pyhf.svg
378378
:target: https://badge.fury.io/py/pyhf

binder/postBuild

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,5 @@
11
python -m pip install --upgrade '.[all]'
2-
python -m pip install altair
2+
python -m pip install --upgrade \
3+
ipywidgets \
4+
ipympl \
5+
altair

docs/conf.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -515,6 +515,12 @@ def setup(app):
515515
r'https://doi\.org/10\.31526/.*',
516516
# https://doi.org/10.1051/epjconf/x DOI URLs will periodically generate 500 Server Error
517517
r'https://doi\.org/10\.1051/epjconf/.*',
518+
# https://indico.desy.de/event/22731/contributions/47953/ is frequently generating 403 Client Error
519+
r'https://indico.desy.de/event/22731/.*',
520+
# https://indico.belle2.org/event/8470/contributions/55871/ is frequently generating 403 Client Error
521+
r'https://indico.belle2.org/event/8470/.*',
522+
# CERN doesn't maintain its SSL certs well enough to not have SSLErrors
523+
r'https://twiki.cern.ch/.*',
518524
# tags for a release won't exist until it is made, but the release notes
519525
# and ReadTheDocs need to reference them
520526
r'https://github.com/scikit-hep/pyhf/releases/tag/.*',

docs/examples.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Examples
44
Try out in Binder! |Binder|
55

66
.. |Binder| image:: https://mybinder.org/badge_logo.svg
7-
:target: https://mybinder.org/v2/gh/scikit-hep/pyhf/main?filepath=docs%2Fexamples%2Fnotebooks%2Fbinderexample%2FStatisticalAnalysis.ipynb
7+
:target: https://mybinder.org/v2/gh/scikit-hep/pyhf/main?labpath=docs%2Fexamples%2Fnotebooks%2Fbinderexample%2FStatisticalAnalysis.ipynb
88

99
Notebooks:
1010

docs/examples/notebooks/binderexample/StatisticalAnalysis.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
"from pyhf.contrib.viz import brazil\n",
1717
"\n",
1818
"import base64\n",
19-
"from IPython.core.display import display, HTML\n",
19+
"from IPython.display import display, HTML\n",
2020
"from ipywidgets import interact, fixed"
2121
]
2222
},
@@ -1248,7 +1248,7 @@
12481248
}
12491249
],
12501250
"source": [
1251-
"%matplotlib notebook\n",
1251+
"%matplotlib widget\n",
12521252
"fig, ax = plt.subplots(1, 1)\n",
12531253
"fig.set_size_inches(10, 5)\n",
12541254
"ax.set_ylim(0, 1.5 * np.max(workspace.data(pdf, include_auxdata=False)))\n",

pyproject.toml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,7 @@ test = [
9898
"pytest-benchmark[histogram]",
9999
"pytest-console-scripts>=1.4.0",
100100
"pytest-mpl",
101+
"ipympl>=0.3.0",
101102
"pydocstyle",
102103
"papermill~=2.3.4",
103104
"scrapbook~=0.5.0",
@@ -107,10 +108,10 @@ test = [
107108
]
108109
docs = [
109110
"pyhf[xmlio,contrib]",
110-
"sphinx>=5.1.1", # c.f. https://github.com/scikit-hep/pyhf/pull/1926
111+
"sphinx>=7.0.0", # c.f. https://github.com/scikit-hep/pyhf/pull/2271
111112
"sphinxcontrib-bibtex~=2.1",
112113
"sphinx-click",
113-
"sphinx_rtd_theme",
114+
"sphinx-rtd-theme>=1.3.0rc1", # c.f. https://github.com/scikit-hep/pyhf/pull/2271
114115
"nbsphinx!=0.8.8", # c.f. https://github.com/spatialaudio/nbsphinx/issues/620
115116
"ipywidgets",
116117
"sphinx-issues",

0 commit comments

Comments
 (0)