Add badges to documentation website

PainterQubits · Apr 21, 2024 · a1862db · a1862db
1 parent b62897f
commit a1862db
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,12 +1,16 @@
 # ParamDB
 
+<!-- start badges -->
+
 [![PyPI Latest Release](https://img.shields.io/pypi/v/paramdb)](https://pypi.org/project/paramdb/)
 [![PyPI Python Versions](https://img.shields.io/pypi/pyversions/paramdb)](https://pypi.org/project/paramdb/)
 [![License](https://img.shields.io/pypi/l/paramdb)](https://github.com/PainterQubits/paramdb/blob/main/LICENSE)
 [![CI](https://github.com/PainterQubits/paramdb/actions/workflows/ci.yml/badge.svg)](https://github.com/PainterQubits/paramdb/actions/workflows/ci.yml)
 [![Codecov](https://codecov.io/github/PainterQubits/paramdb/branch/main/graph/badge.svg?token=PQEJWLBTBK)](https://codecov.io/github/PainterQubits/paramdb)
 [![Documentation Status](https://readthedocs.org/projects/paramdb/badge/?version=stable)](https://paramdb.readthedocs.io/en/stable/?badge=stable)
 
+<!-- end badges -->
+
 <!-- start intro -->
 
 Python package for storing and retrieving experiment parameters.

diff --git a/docs/index.md b/docs/index.md
@@ -1,5 +1,10 @@
 # ParamDB
 
+```{include} ../README.md
+:start-after: <!-- start badges -->
+:end-before: <!-- end badges -->
+```
+
 ```{include} ../README.md
 :start-after: <!-- start intro -->
 :end-before: <!-- end intro -->