Skip to content

Commit 9fd99be

Browse files
docs: Add section for tutorial and docs to README (#1789)
* Add section to README that links to the pyhf tutorial. - c.f. https://pyhf.github.io/pyhf-tutorial/ * Add badge to the Jupyter Book tutorial to the top of the README. * Add section to README that explicitly links to the documentation. - c.f. https://pyhf.readthedocs.io/
1 parent 2533bd9 commit 9fd99be

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

README.rst

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ pure-python fitting/limit-setting/interval estimation HistFactory-style
88

99
|GitHub Project| |DOI| |JOSS DOI| |Scikit-HEP| |NSF Award Number|
1010

11-
|Docs from latest| |Docs from master| |Binder|
11+
|Docs from latest| |Docs from master| |Jupyter Book tutorial| |Binder|
1212

1313
|PyPI version| |Conda-forge version| |Supported Python versions| |Docker Hub pyhf| |Docker Hub pyhf CUDA|
1414

@@ -32,6 +32,14 @@ to support modern computational graph libraries such as PyTorch and
3232
TensorFlow in order to make use of features such as autodifferentiation
3333
and GPU acceleration.
3434

35+
User Guide
36+
----------
37+
38+
For an in depth walkthrough of usage of the latest release of ``pyhf`` visit the |pyhf tutorial|_.
39+
40+
.. |pyhf tutorial| replace:: ``pyhf`` tutorial
41+
.. _pyhf tutorial: https://pyhf.github.io/pyhf-tutorial/
42+
3543
Hello World
3644
-----------
3745

@@ -261,6 +269,14 @@ To uninstall run
261269
262270
python -m pip uninstall pyhf
263271
272+
Documentation
273+
-------------
274+
275+
For model specification, API reference, examples, and answers to FAQs visit the |pyhf documentation|_.
276+
277+
.. |pyhf documentation| replace:: ``pyhf`` documentation
278+
.. _pyhf documentation: https://pyhf.readthedocs.io/
279+
264280
Questions
265281
---------
266282
@@ -344,6 +360,8 @@ and grant `OAC-1450377 <https://www.nsf.gov/awardsearch/showAward?AWD_ID=1450377
344360
:target: https://pyhf.readthedocs.io/
345361
.. |Docs from master| image:: https://img.shields.io/badge/docs-master-blue.svg
346362
:target: https://scikit-hep.github.io/pyhf
363+
.. |Jupyter Book tutorial| image:: https://jupyterbook.org/_images/badge.svg
364+
:target: https://pyhf.github.io/pyhf-tutorial/
347365
.. |Binder| image:: https://mybinder.org/badge_logo.svg
348366
:target: https://mybinder.org/v2/gh/scikit-hep/pyhf/master?filepath=docs%2Fexamples%2Fnotebooks%2Fbinderexample%2FStatisticalAnalysis.ipynb
349367

0 commit comments

Comments
 (0)