Merge pull request #177 from smash-transport/roch/zenodo_badge

Add Zenodo badge and fix contributors rendering
smash-transport · Dec 19, 2023 · 16c957a · 16c957a
2 parents 5ad42e9 + a8327e8
commit 16c957a
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -13,5 +13,9 @@
   <img src="https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat" alt="documentation">
 </a>
 
+<a href="https://doi.org/10.5281/zenodo.10288638">
+  <img src="https://zenodo.org/badge/DOI/10.5281/zenodo.10288638.svg" alt="DOI">
+</a>
+
 This package is designed to assist users of the [SMASH](https://smash-transport.github.io/) and [JETSCAPE/X-SCAPE](https://jetscape.org/) codes to analyze the output of the simulation data.
 It contains multiple classes to read in the simulation outputs in OSCAR2013/OSCAR2013Extended format or the hadron output of JETSCAPE/X-SCAPE.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -42,7 +42,6 @@
 # You can specify multiple suffix as a list of string:
 #
 source_suffix = ['.rst', '.md']
-#source_suffix = '.rst'
 
 # The master toctree document.
 master_doc = 'index'

diff --git a/docs/source/credits.md b/docs/source/credits.md
@@ -0,0 +1,2 @@
+```{include} ../../CONTRIBUTORS.md
+```
diff --git a/docs/source/credits.rst b/docs/source/credits.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -9,6 +9,10 @@ SPARKX
 
    <h2 style="font-size: 18px;">Software Package for Analyzing Relativistic Kinematics in Collision eXperiments</b></h2>
 
+   <a href="https://doi.org/10.5281/zenodo.10288638">
+      <img src="https://zenodo.org/badge/DOI/10.5281/zenodo.10288638.svg" alt="DOI">
+   </a>
+
 This package is designed to assist users of the `SMASH <https://smash-transport.github.io/>`_ and `JETSCAPE/X-SCAPE <https://jetscape.org/>`_ codes to analyze the output of the simulation data.
 It contains multiple classes to read in the simulation outputs in OSCAR2013/OSCAR2013Extended format or the hadron output of JETSCAPE/X-SCAPE.
 
@@ -19,7 +23,7 @@ It contains multiple classes to read in the simulation outputs in OSCAR2013/OSCA
    classes/index
    utilities/index
    license
-   credits
+   credits.md
 
 
 Indices and tables

diff --git a/docs/source/requirements.txt b/docs/source/requirements.txt