Skip to content

Commit cb91813

Browse files
casenavecasenave
committed
📄 Improve badges
1 parent 9e5e439 commit cb91813

File tree

5 files changed

+60
-55
lines changed

5 files changed

+60
-55
lines changed

‎README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
![GitHub stars](https://img.shields.io/github/stars/PLAID-lib/plaid?style=social)
2-
[![CI Status](https://github.com/PLAID-lib/plaid/actions/workflows/testing.yml/badge.svg)](https://github.com/PLAID-lib/plaid/actions/workflows/testing.yml)
3-
[![codecov](https://codecov.io/gh/plaid-lib/plaid/branch/main/graph/badge.svg)](https://app.codecov.io/gh/plaid-lib/plaid/tree/main?search=&displayType=list)
4-
[![License](https://anaconda.org/conda-forge/plaid/badges/license.svg)](https://github.com/PLAID-lib/plaid/blob/main/LICENSE.txt)
5-
[![Documentation Status](https://readthedocs.org/projects/plaid-lib/badge/?version=latest)](https://plaid-lib.readthedocs.io/en/latest/?badge=latest)
6-
[![Conda Version](https://anaconda.org/conda-forge/plaid/badges/version.svg)](https://anaconda.org/conda-forge/plaid)
7-
[![Conda Release Date](https://anaconda.org/conda-forge/plaid/badges/latest_release_date.svg)](https://anaconda.org/conda-forge/plaid)
8-
[![Conda Platforms](https://anaconda.org/conda-forge/plaid/badges/platforms.svg)](https://anaconda.org/conda-forge/plaid)
9-
[![Conda Downloads](https://anaconda.org/conda-forge/plaid/badges/downloads.svg)](https://anaconda.org/conda-forge/plaid)
10-
<!-- ![Python Version](https://img.shields.io/pypi/pyversions/plaid-lib)
11-
[![PyPI Version](https://img.shields.io/pypi/v/plaid-lib)](https://pypi.org/project/plaid-lib/)
12-
[![codecov](https://codecov.io/gh/PLAID-lib/plaid/branch/main/graph/badge.svg)](https://codecov.io/gh/PLAID-lib/plaid) -->
1+
<div align="center">
2+
<img src="https://plaid-lib.github.io/assets/images/PLAID-large-logo.png" width="300">
3+
</div>
4+
5+
| | |
6+
| --- | --- |
7+
| Testing | [![CI Status](https://github.com/PLAID-lib/plaid/actions/workflows/testing.yml/badge.svg)](https://github.com/PLAID-lib/plaid/actions/workflows/testing.yml) [![Documentation Status](https://readthedocs.org/projects/plaid-lib/badge/?version=latest)](https://plaid-lib.readthedocs.io/en/latest/?badge=latest) [![Coverage](https://codecov.io/gh/plaid-lib/plaid/branch/main/graph/badge.svg)](https://app.codecov.io/gh/plaid-lib/plaid/tree/main?search=&displayType=list) ![Last Commit](https://img.shields.io/github/last-commit/PLAID-lib/plaid/main) |
8+
| Package | [![PyPI Latest Release](https://img.shields.io/pypi/v/pyplaid.svg)](https://pypi.org/project/pyplaid/) [![Conda Latest Release](https://anaconda.org/conda-forge/plaid/badges/version.svg)](https://anaconda.org/conda-forge/plaid) ![Platform](https://img.shields.io/badge/platform-any-blue) ![Python Version](https://img.shields.io/pypi/pyversions/pyplaid) [![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/plaid.svg?label=Conda%20downloads)](https://anaconda.org/conda-forge/plaid) |
9+
| Meta | [![License - BSD 3-Clause](https://anaconda.org/conda-forge/plaid/badges/license.svg)](https://github.com/PLAID-lib/plaid/blob/main/LICENSE.txt) ![GitHub stars](https://img.shields.io/github/stars/PLAID-lib/plaid?style=social) |
10+
11+
<!-- [![PyPI Downloads](https://img.shields.io/pypi/dm/pyplaid.svg?label=PyPI%20downloads)](https://pypi.org/project/pyplaid/) -->
12+
<!-- [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3509134.svg)](https://doi.org/10.5281/zenodo.3509134) -->
1313

1414

1515
# Physics Learning AI Datamodel (PLAID)

‎docs/conf.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,7 @@
187187
# html_theme = 'sphinx_rtd_theme'
188188
html_theme = 'furo'
189189
html_logo = "source/images/plaid.jpg"
190+
html_favicon = "source/images/plaid.jpg"
190191

191192
# cf https://pradyunsg.me/furo/customisation/edit-button/
192193
html_theme_options = {
@@ -204,7 +205,7 @@
204205
# Add any paths that contain custom static files (such as style sheets) here,
205206
# relative to this directory. They are copied after the builtin static files,
206207
# so a file named "default.css" will overwrite the builtin "default.css".
207-
# html_static_path = ['_static']
208+
# html_static_path = ["_static"]
208209

209210
# A list of paths that contain extra files not directly related to the documentation,
210211
# such as robots.txt or .htaccess.

‎docs/index.rst

Lines changed: 41 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -6,43 +6,51 @@
66
PLAID documentation
77
===================
88

9-
.. ![GitHub stars](https://img.shields.io/github/stars/PLAID-lib/plaid?style=social)
10-
.. [![CI Status](https://github.com/PLAID-lib/plaid/actions/workflows/testing.yml/badge.svg)](https://github.com/PLAID-lib/plaid/actions/workflows/testing.yml)
11-
.. [![codecov](https://codecov.io/gh/plaid-lib/plaid/branch/main/graph/badge.svg)](https://app.codecov.io/gh/plaid-lib/plaid/tree/main)
12-
.. [![License](https://anaconda.org/conda-forge/plaid/badges/license.svg)](https://github.com/PLAID-lib/plaid/blob/main/LICENSE.txt)
13-
.. [![Documentation Status](https://readthedocs.org/projects/plaid-lib/badge/?version=latest)](https://plaid-lib.readthedocs.io/en/latest/?badge=latest)
14-
.. [![Conda Version](https://anaconda.org/conda-forge/plaid/badges/version.svg)](https://anaconda.org/conda-forge/plaid)
15-
.. [![Conda Release Date](https://anaconda.org/conda-forge/plaid/badges/latest_release_date.svg)](https://anaconda.org/conda-forge/plaid)
16-
.. [![Conda Platforms](https://anaconda.org/conda-forge/plaid/badges/platforms.svg)](https://anaconda.org/conda-forge/plaid)
17-
.. [![Conda Downloads](https://anaconda.org/conda-forge/plaid/badges/downloads.svg)](https://anaconda.org/conda-forge/plaid)
18-
19-
.. image:: https://img.shields.io/github/stars/PLAID-lib/plaid?style=social
20-
:target: https://github.com/PLAID-lib/plaid
21-
:alt: GitHub Stars
22-
.. image:: https://github.com/PLAID-lib/plaid/actions/workflows/testing.yml/badge.svg
9+
.. image:: https://plaid-lib.github.io/assets/images/PLAID-large-logo.png
10+
:align: center
11+
:width: 300px
12+
13+
+-------------+-------------------------------------------------------------------------------+
14+
| **Testing** | |CI Status| |Docs| |Coverage| |Last Commit| |
15+
+-------------+-------------------------------------------------------------------------------+
16+
| **Package** | |PyPI Version| |Conda Version| |Platform| |Python Version| |Conda Downloads| |
17+
+-------------+-------------------------------------------------------------------------------+
18+
| **Meta** | |License| |GitHub Stars| |
19+
+-------------+-------------------------------------------------------------------------------+
20+
21+
22+
.. |CI Status| image:: https://github.com/PLAID-lib/plaid/actions/workflows/testing.yml/badge.svg
2323
:target: https://github.com/PLAID-lib/plaid/actions/workflows/testing.yml
24-
:alt: CI Status
25-
.. image:: https://codecov.io/gh/plaid-lib/plaid/branch/main/graph/badge.svg
26-
:target: https://app.codecov.io/gh/plaid-lib/plaid/tree/main?search=&displayType=list
27-
:alt: codecov
28-
.. image:: https://anaconda.org/conda-forge/plaid/badges/license.svg
29-
:target: https://github.com/PLAID-lib/plaid/blob/main/LICENSE.txt
30-
:alt: License
31-
.. image:: https://readthedocs.org/projects/plaid-lib/badge/?version=latest
24+
25+
.. |Docs| image:: https://readthedocs.org/projects/plaid-lib/badge/?version=latest
3226
:target: https://plaid-lib.readthedocs.io/en/latest/?badge=latest
33-
:alt: Docs Status
34-
.. image:: https://anaconda.org/conda-forge/plaid/badges/version.svg
35-
:target: https://anaconda.org/conda-forge/plaid
36-
:alt: Conda Version
37-
.. image:: https://anaconda.org/conda-forge/plaid/badges/latest_release_date.svg
38-
:target: https://anaconda.org/conda-forge/plaid
39-
:alt: Conda Release Date
40-
.. image:: https://anaconda.org/conda-forge/plaid/badges/platforms.svg
27+
28+
.. |Coverage| image:: https://codecov.io/gh/plaid-lib/plaid/branch/main/graph/badge.svg
29+
:target: https://app.codecov.io/gh/plaid-lib/plaid/tree/main?search=&displayType=list
30+
31+
.. |Last Commit| image:: https://img.shields.io/github/last-commit/PLAID-lib/plaid/main
32+
:target: https://github.com/PLAID-lib/plaid/commits/main
33+
34+
.. |PyPI Version| image:: https://img.shields.io/pypi/v/pyplaid.svg
35+
:target: https://pypi.org/project/pyplaid/
36+
37+
.. |Conda Version| image:: https://anaconda.org/conda-forge/plaid/badges/version.svg
4138
:target: https://anaconda.org/conda-forge/plaid
42-
:alt: Conda Platforms
43-
.. image:: https://anaconda.org/conda-forge/plaid/badges/downloads.svg
39+
40+
.. |Platform| image:: https://img.shields.io/badge/platform-any-blue
41+
:target: https://github.com/PLAID-lib/plaid
42+
43+
.. |Python Version| image:: https://img.shields.io/pypi/pyversions/pyplaid
44+
:target: https://github.com/PLAID-lib/plaid
45+
46+
.. |Conda Downloads| image:: https://img.shields.io/conda/dn/conda-forge/plaid.svg?label=Conda%20downloads
4447
:target: https://anaconda.org/conda-forge/plaid
45-
:alt: Conda Downloads
48+
49+
.. |License| image:: https://anaconda.org/conda-forge/plaid/badges/license.svg
50+
:target: https://github.com/PLAID-lib/plaid/blob/main/LICENSE.txt
51+
52+
.. |GitHub Stars| image:: https://img.shields.io/github/stars/PLAID-lib/plaid?style=social
53+
:target: https://github.com/PLAID-lib/plaid
4654

4755

4856
PLAID (Physics Learning AI Datamodel) is a library proposing an implementation for a datamodel tailored for AI and ML learning of physics problems.

‎docs/source/getting_started.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,12 @@ Everything you need to know to start using the PLAID.
55
---
66

77
- [Getting Started](#getting-started)
8-
- [1. Install guide](#1-install-guide)
9-
- [1.1 Using the library](#11-using-the-library)
10-
- [1.2 Contributing to the library](#12-contributing-to-the-library)
11-
- [2. Test installation](#2-test-installation)
8+
- [1. Using the library](#1-using-the-library)
9+
- [2. Contributing to the library](#2-contributing-to-the-library)
1210

1311
---
1412

15-
## 1. Install guide
16-
17-
### 1.1 Using the library
13+
## 1 Using the library
1814

1915
To use the library, the simplest way is to install the conda-forge or PyPi package:
2016

@@ -23,7 +19,7 @@ conda install -c conda-forge plaid
2319
pip install pyplaid
2420
```
2521

26-
### 1.2 Contributing to the library
22+
## 2 Contributing to the library
2723

2824
To contribute to the library, you need to clone the repo using git:
2925

‎pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ dynamic = ["version"]
4545
write_to = "src/plaid/_version.py"
4646

4747
[project.urls]
48-
homepage = "https://github.com/PLAID-lib/plaid"
48+
homepage = "https://plaid-lib.github.io"
4949
documentation = "https://plaid-lib.readthedocs.io"
5050
repository = "https://github.com/PLAID-lib/plaid"
5151

0 commit comments

Comments
 (0)