Skip to content

Commit 1478105

Browse files
Restore cython tutorial (#1026)
Remove nitpicky mode, fix link check. --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent 2436bef commit 1478105

7 files changed

+404
-8
lines changed

doc/_static/interactive_demo.ipynb

+20-3
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,23 @@
1111
"cell_type": "code",
1212
"execution_count": null,
1313
"metadata": {},
14-
"outputs": [],
14+
"outputs": [
15+
{
16+
"data": {
17+
"application/vnd.jupyter.widget-view+json": {
18+
"model_id": "1ef533261cdf44c88ab722730615534d",
19+
"version_major": 2,
20+
"version_minor": 0
21+
},
22+
"text/plain": [
23+
"HBox(children=(Output(), VBox(children=(HBox(children=(Button(description='Fit', style=ButtonStyle()), ToggleB…"
24+
]
25+
},
26+
"execution_count": null,
27+
"metadata": {},
28+
"output_type": "execute_result"
29+
}
30+
],
1531
"source": [
1632
"import numpy as np\n",
1733
"from scipy.stats import norm\n",
@@ -36,6 +52,7 @@
3652
}
3753
],
3854
"metadata": {
55+
"keep_output": true,
3956
"kernelspec": {
4057
"display_name": "Python 3.8.13 ('venv': venv)",
4158
"language": "python",
@@ -50,8 +67,8 @@
5067
"mimetype": "text/x-python",
5168
"name": "python",
5269
"nbconvert_exporter": "python",
53-
"pygments_lexer": "python3",
54-
"version": "3.9.13"
70+
"pygments_lexer": "ipython3",
71+
"version": "3.12.4"
5572
},
5673
"vscode": {
5774
"interpreter": {

doc/bibliography.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _scipy: https://www.scipy.org/
1+
.. _scipy: https://scipy.org/
22
.. _scipy.optimize: https://docs.scipy.org/doc/scipy/tutorial/optimize.html
33
.. _numba: https://numba.pydata.org
44
.. _numba_stats: https://github.com/HDembinski/numba-stats
@@ -10,7 +10,7 @@
1010
.. _threeML: https://github.com/threeML/threeML
1111
.. _Veusz: https://github.com/veusz/veusz
1212
.. _TensorProb: https://github.com/tensorprob/tensorprob
13-
.. _Scikit-HEP: http://scikit-hep.org
13+
.. _Scikit-HEP: https://scikit-hep.org
1414
.. _probfit: https://github.com/scikit-hep/probfit
1515
.. _gammapy: https://github.com/gammapy/gammapy
1616
.. _flavio: https://github.com/flav-io/flavio

doc/conf.py

+3-1
Original file line numberDiff line numberDiff line change
@@ -83,5 +83,7 @@
8383
"--InlineBackend.rc=figure.dpi=96",
8484
]
8585

86-
linkcheck_timeout = 3
86+
linkcheck_timeout = 10
8787
linkcheck_allow_unauthorized = True
88+
linkcheck_report_timeouts_as_broken = False
89+
linkcheck_ignore = ["https://doi.org/10.2307%2F2347496"]

doc/notebooks/cython.ipynb

+376
Large diffs are not rendered by default.

doc/tutorials.rst

+1
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ Important for most users are only the first two entries.
2525
notebooks/roofit
2626
notebooks/external_minimizer
2727
notebooks/generic_least_squares
28+
notebooks/cython
2829

2930
RooFit tutorials
3031
----------------

noxfile.py

+1-2
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,6 @@ def doc(session: nox.Session) -> None:
8585
# link check
8686
session.run(
8787
"sphinx-build",
88-
"-n", # nitpicky mode
8988
"-T", # full tracebacks
9089
"-v",
9190
"-b=html",
@@ -95,7 +94,7 @@ def doc(session: nox.Session) -> None:
9594

9695

9796
@nox.session(python="3.11", reuse_venv=True)
98-
def linkcheck(session: nox.Session) -> None:
97+
def links(session: nox.Session) -> None:
9998
"""Check all links in the documentation."""
10099
session.install("--only-binary=:all:", "-e.[test,doc]")
101100

pyproject.toml

+1
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,7 @@ pydocstyle.convention = "numpy"
106106
"test_*.py" = ["B", "D"]
107107
"*.ipynb" = ["D"]
108108
"automatic_differentiation.ipynb" = ["F821"]
109+
"cython.ipynb" = ["F821"]
109110
".ci/*.py" = ["D"]
110111
"bench/*.py" = ["D"]
111112
"doc/*.py" = ["D"]

0 commit comments

Comments
 (0)