Skip to content

Commit

Permalink
docs: Improve badge layout and fix broken Docker badge (#1497)
Browse files Browse the repository at this point in the history 
* Update broken Docker deployment badge with GitHub Actions Docker workflow status badge
* Remove Docker stars and pulls badges
* Add pyhf CUDA enabled Docker images badge
* Revise badge layout to prioritize user needs (docs and distributions) over developer interests (code quality and CI status)
  • Loading branch information
@matthewfeickert
matthewfeickert authored Jun 21, 2021
1 parent ccc32c1 commit 302af0b
Showing 1 changed file with 30 additions and 26 deletions.
56 changes: 30 additions & 26 deletions README.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,14 @@ pure-python fitting/limit-setting/interval estimation HistFactory-style

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

|GitHub Actions Status: CI| |GitHub Actions Status: Docs| |GitHub Actions Status: Publish|
|Docker Automated| |Code Coverage| |CodeFactor| |pre-commit.ci Status| |Code style: black|

|Docs from latest| |Docs from master| |Binder|

|PyPI version| |Conda-forge version| |Supported Python versions| |Docker Stars| |Docker
Pulls|
|PyPI version| |Conda-forge version| |Supported Python versions| |Docker Hub pyhf| |Docker Hub pyhf CUDA|

|Code Coverage| |CodeFactor| |pre-commit.ci Status| |Code style: black|

|GitHub Actions Status: CI| |GitHub Actions Status: Docs| |GitHub Actions Status: Publish|
|GitHub Actions Status: Docker|

The HistFactory p.d.f. template
[`CERN-OPEN-2012-016 <https://cds.cern.ch/record/1456844>`__] is per-se
Expand Down Expand Up @@ -336,36 +337,39 @@ and grant `OAC-1450377 <https://www.nsf.gov/awardsearch/showAward?AWD_ID=1450377
:target: https://scikit-hep.org/
.. |NSF Award Number| image:: https://img.shields.io/badge/NSF-1836650-blue.svg
:target: https://nsf.gov/awardsearch/showAward?AWD_ID=1836650
.. |GitHub Actions Status: CI| image:: https://github.com/scikit-hep/pyhf/workflows/CI/CD/badge.svg?branch=master
:target: https://github.com/scikit-hep/pyhf/actions?query=workflow%3ACI%2FCD+branch%3Amaster
.. |GitHub Actions Status: Docs| image:: https://github.com/scikit-hep/pyhf/workflows/Docs/badge.svg?branch=master
:target: https://github.com/scikit-hep/pyhf/actions?query=workflow%3ADocs+branch%3Amaster
.. |GitHub Actions Status: Publish| image:: https://github.com/scikit-hep/pyhf/workflows/publish%20distributions/badge.svg?branch=master
:target: https://github.com/scikit-hep/pyhf/actions?query=workflow%3A%22publish+distributions%22+branch%3Amaster
.. |Docker Automated| image:: https://img.shields.io/docker/automated/pyhf/pyhf.svg
:target: https://hub.docker.com/r/pyhf/pyhf/
.. |Code Coverage| image:: https://codecov.io/gh/scikit-hep/pyhf/graph/badge.svg?branch=master
:target: https://codecov.io/gh/scikit-hep/pyhf?branch=master
.. |CodeFactor| image:: https://www.codefactor.io/repository/github/scikit-hep/pyhf/badge
:target: https://www.codefactor.io/repository/github/scikit-hep/pyhf
.. |pre-commit.ci Status| image:: https://results.pre-commit.ci/badge/github/scikit-hep/pyhf/master.svg
:target: https://results.pre-commit.ci/latest/github/scikit-hep/pyhf/master
:alt: pre-commit.ci status
.. |Code style: black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
.. |Docs from latest| image:: https://img.shields.io/badge/docs-v0.6.1-blue.svg
:target: https://pyhf.readthedocs.io/
.. |Docs from master| image:: https://img.shields.io/badge/docs-master-blue.svg
:target: https://scikit-hep.github.io/pyhf
.. |Binder| image:: https://mybinder.org/badge_logo.svg
:target: https://mybinder.org/v2/gh/scikit-hep/pyhf/master?filepath=docs%2Fexamples%2Fnotebooks%2Fbinderexample%2FStatisticalAnalysis.ipynb
.. |PyPI version| image:: https://badge.fury.io/py/pyhf.svg
:target: https://badge.fury.io/py/pyhf
.. |Conda-forge version| image:: https://img.shields.io/conda/vn/conda-forge/pyhf.svg
:target: https://github.com/conda-forge/pyhf-feedstock
.. |Supported Python versions| image:: https://img.shields.io/pypi/pyversions/pyhf.svg
:target: https://pypi.org/project/pyhf/
.. |Docker Stars| image:: https://img.shields.io/docker/stars/pyhf/pyhf.svg
:target: https://hub.docker.com/r/pyhf/pyhf/
.. |Docker Pulls| image:: https://img.shields.io/docker/pulls/pyhf/pyhf.svg
:target: https://hub.docker.com/r/pyhf/pyhf/
.. |Docker Hub pyhf| image:: https://img.shields.io/badge/pyhf-v0.6.1-blue?logo=Docker
:target: https://hub.docker.com/r/pyhf/pyhf/tags
.. |Docker Hub pyhf CUDA| image:: https://img.shields.io/badge/pyhf-CUDA-blue?logo=Docker
:target: https://hub.docker.com/r/pyhf/cuda/tags
.. |Code Coverage| image:: https://codecov.io/gh/scikit-hep/pyhf/graph/badge.svg?branch=master
:target: https://codecov.io/gh/scikit-hep/pyhf?branch=master
.. |CodeFactor| image:: https://www.codefactor.io/repository/github/scikit-hep/pyhf/badge
:target: https://www.codefactor.io/repository/github/scikit-hep/pyhf
.. |pre-commit.ci Status| image:: https://results.pre-commit.ci/badge/github/scikit-hep/pyhf/master.svg
:target: https://results.pre-commit.ci/latest/github/scikit-hep/pyhf/master
:alt: pre-commit.ci status
.. |Code style: black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
.. |GitHub Actions Status: CI| image:: https://github.com/scikit-hep/pyhf/workflows/CI/CD/badge.svg?branch=master
:target: https://github.com/scikit-hep/pyhf/actions?query=workflow%3ACI%2FCD+branch%3Amaster
.. |GitHub Actions Status: Docs| image:: https://github.com/scikit-hep/pyhf/workflows/Docs/badge.svg?branch=master
:target: https://github.com/scikit-hep/pyhf/actions?query=workflow%3ADocs+branch%3Amaster
.. |GitHub Actions Status: Publish| image:: https://github.com/scikit-hep/pyhf/workflows/publish%20distributions/badge.svg?branch=master
:target: https://github.com/scikit-hep/pyhf/actions?query=workflow%3A%22publish+distributions%22+branch%3Amaster
.. |GitHub Actions Status: Docker| image:: https://github.com/scikit-hep/pyhf/actions/workflows/docker.yml/badge.svg?branch=master
:target: https://github.com/scikit-hep/pyhf/actions/workflows/docker.yml?query=branch%3Amaster

0 comments on commit 302af0b

Please sign in to comment.