From 9e45ccf75da06acf805e093beae5724dd8124b45 Mon Sep 17 00:00:00 2001 From: "Adam M. Krajewski" Date: Thu, 9 Feb 2023 14:57:17 -0500 Subject: [PATCH] - polishing the docs for 0.10.2 release - docs updated with badges --- README.md | 11 ++++++++--- docs/index.rst | 28 ++++++++++++++++++++++------ 2 files changed, 30 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 826d11e..c10ce36 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,12 @@ ## pySIPFENN -[![PyPI version](https://badge.fury.io/py/pysipfenn.svg)](https://badge.fury.io/py/pysipfenn) -[![Python 3.9](https://img.shields.io/badge/python-3.9-blue.svg)](https://www.python.org/downloads/release/python-390/) -[![Python 3.10](https://img.shields.io/badge/python-3.10-blue.svg)](https://www.python.org/downloads/release/python-3100/) +![GitHub top language](https://img.shields.io/github/languages/top/PhasesResearchLab/pysipfenn) +![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pysipfenn) +![PyPI](https://img.shields.io/pypi/v/pysipfenn) +![PyPI - License](https://img.shields.io/pypi/l/pysipfenn) +![GitHub last commit (by committer)](https://img.shields.io/github/last-commit/PhasesResearchLab/pysipfenn?label=Last%20Commit) +![GitHub Release Date - Published_At](https://img.shields.io/github/release-date/PhasesResearchLab/pysipfenn?label=Last%20Release) +![GitHub commits since tagged version](https://img.shields.io/github/commits-since/PhasesResearchLab/pysipfenn/v0.10.1?color=g) +[![DOI](https://img.shields.io/badge/DOI-10.1016%2Fj.commatsci.2022.111254-blue)](https://doi.org/10.1016/j.commatsci.2022.111254) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7373089.svg)](https://doi.org/10.5281/zenodo.7373089) This repository contains diff --git a/docs/index.rst b/docs/index.rst index d27eaf7..256f7ae 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,16 +7,32 @@ pySIPFENN ========= -.. image:: https://img.shields.io/badge/python-3.9-blue.svg - :target: https://www.python.org/downloads/release/python-390/ +.. image:: https://img.shields.io/github/languages/top/PhasesResearchLab/pysipfenn + :alt: GitHub top language -.. image:: https://img.shields.io/badge/python-3.10-blue.svg +.. image:: https://img.shields.io/pypi/pyversions/pysipfenn + :alt: PyPI - Python Version :target: https://www.python.org/downloads/release/python-3100/ -.. image:: https://badge.fury.io/py/pysipfenn.svg - :target: https://badge.fury.io/py/pysipfenn +.. image:: https://img.shields.io/pypi/l/pysipfenn + :alt: PyPI - License -.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.7373089.svg +.. image:: https://img.shields.io/pypi/v/pysipfenn + :alt: PyPI + +.. image:: https://img.shields.io/github/last-commit/PhasesResearchLab/pysipfenn?label=Last%20Commit + :alt: GitHub last commit (by committer) + +.. image:: https://img.shields.io/github/release-date/PhasesResearchLab/pysipfenn?label=Last%20Release + :alt: GitHub Release Date - Published_At + +.. image:: https://img.shields.io/github/commits-since/PhasesResearchLab/pysipfenn/v0.10.1?color=g + :alt: GitHub commits since tagged version + +.. image:: https://img.shields.io/badge/DOI-10.1016%2Fj.commatsci.2022.111254-blue + :target: https://doi.org/10.1016/j.commatsci.2022.111254 + +.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.7373089.svg? :target: https://doi.org/10.5281/zenodo.7373089