Add ReadTheDocs status badge

cta-observatory · Feb 16, 2024 · 3ba884f · 3ba884f
1 parent 5e28451
commit 3ba884f
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -2,6 +2,8 @@
 
 [![CI](https://github.com/cta-observatory/iact-estimator/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/cta-observatory/iact-estimator/actions/workflows/ci.yml)
 
+[![docs](https://readthedocs.org/projects/iact-estimator/badge/?version=latest)](https://iact-estimator.readthedocs.io/latest/?badge=latest)
+
 ``iact-estimator`` is a Python3-based package that allows
 the estimation of the performance of an IACT telescope system
 to detect a gamma-ray source.

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -6,12 +6,16 @@
 Documentation of ``iact-estimator``
 ===================================
 
-|ci|
+|ci| |docs|
 
 .. |ci| image:: https://github.com/cta-observatory/iact-estimator/actions/workflows/ci.yml/badge.svg?branch=main
     :alt: CI
     :target: https://github.com/cta-observatory/iact-estimator/actions/workflows/ci.yml
 
+.. |docs| image:: https://readthedocs.org/projects/iact-estimator/badge/?version=latest
+    :target: https://iact-estimator.readthedocs.io/latest/?badge=latest
+    :alt: Documentation Status
+
 ``iact-estimator`` is a Python3 package which allows
 to evaluate the ability of an IACT telescope system
 to detect a gamma-ray source.