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(backport): Update docs build requirements #2281

Merged
merged 5 commits into from
Aug 16, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,3 @@ python:
path: .
extra_requirements:
- docs
system_packages: true
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -372,7 +372,7 @@ and grant `OAC-1450377 <https://www.nsf.gov/awardsearch/showAward?AWD_ID=1450377
.. |Jupyter Book tutorial| image:: https://jupyterbook.org/_images/badge.svg
:target: https://pyhf.github.io/pyhf-tutorial/
.. |Binder| image:: https://mybinder.org/badge_logo.svg
:target: https://mybinder.org/v2/gh/scikit-hep/pyhf/main?filepath=docs%2Fexamples%2Fnotebooks%2Fbinderexample%2FStatisticalAnalysis.ipynb
:target: https://mybinder.org/v2/gh/scikit-hep/pyhf/main?labpath=docs%2Fexamples%2Fnotebooks%2Fbinderexample%2FStatisticalAnalysis.ipynb

.. |PyPI version| image:: https://badge.fury.io/py/pyhf.svg
:target: https://badge.fury.io/py/pyhf
Expand Down
5 changes: 4 additions & 1 deletion binder/postBuild
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
python -m pip install --upgrade '.[all]'
python -m pip install altair
python -m pip install --upgrade \
ipywidgets \
ipympl \
altair
6 changes: 6 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -515,6 +515,12 @@ def setup(app):
r'https://doi\.org/10\.31526/.*',
# https://doi.org/10.1051/epjconf/x DOI URLs will periodically generate 500 Server Error
r'https://doi\.org/10\.1051/epjconf/.*',
# https://indico.desy.de/event/22731/contributions/47953/ is frequently generating 403 Client Error
r'https://indico.desy.de/event/22731/.*',
# https://indico.belle2.org/event/8470/contributions/55871/ is frequently generating 403 Client Error
r'https://indico.belle2.org/event/8470/.*',
# CERN doesn't maintain its SSL certs well enough to not have SSLErrors
r'https://twiki.cern.ch/.*',
# tags for a release won't exist until it is made, but the release notes
# and ReadTheDocs need to reference them
r'https://github.com/scikit-hep/pyhf/releases/tag/.*',
Expand Down
2 changes: 1 addition & 1 deletion docs/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Examples
Try out in Binder! |Binder|

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

Notebooks:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"from pyhf.contrib.viz import brazil\n",
"\n",
"import base64\n",
"from IPython.core.display import display, HTML\n",
"from IPython.display import display, HTML\n",
"from ipywidgets import interact, fixed"
]
},
Expand Down Expand Up @@ -1248,7 +1248,7 @@
}
],
"source": [
"%matplotlib notebook\n",
"%matplotlib widget\n",
"fig, ax = plt.subplots(1, 1)\n",
"fig.set_size_inches(10, 5)\n",
"ax.set_ylim(0, 1.5 * np.max(workspace.data(pdf, include_auxdata=False)))\n",
Expand Down
5 changes: 3 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@ test = [
"pytest-benchmark[histogram]",
"pytest-console-scripts>=1.4.0",
"pytest-mpl",
"ipympl>=0.3.0",
"pydocstyle",
"papermill~=2.3.4",
"scrapbook~=0.5.0",
Expand All @@ -107,10 +108,10 @@ test = [
]
docs = [
"pyhf[xmlio,contrib]",
"sphinx>=5.1.1", # c.f. https://github.com/scikit-hep/pyhf/pull/1926
"sphinx>=7.0.0", # c.f. https://github.com/scikit-hep/pyhf/pull/2271
"sphinxcontrib-bibtex~=2.1",
"sphinx-click",
"sphinx_rtd_theme",
"sphinx-rtd-theme>=1.3.0rc1", # c.f. https://github.com/scikit-hep/pyhf/pull/2271
"nbsphinx!=0.8.8", # c.f. https://github.com/spatialaudio/nbsphinx/issues/620
"ipywidgets",
"sphinx-issues",
Expand Down