Merge pull request #42 from yuqiyuqitan/readthedocs

Add badges
yuqiyuqitan · Jul 1, 2024 · db0e470 · db0e470
2 parents 664090c + cc9c7aa
commit db0e470
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,8 @@
 # SPatial Analysis for CodEX data (SPACEc)
 
+[![Documentation Status](https://readthedocs.org/projects/spacec/badge/?version=latest)](https://spacec.readthedocs.io/en/latest/?badge=latest)
+![example workflow](https://github.com/yuqiyuqitan/SPACEc/actions/workflows/ci.yml/badge.svg)
+
 ## Installation notes
 
 **Note**: Due to some dependencies, we currently only support Python up to `3.9`.

diff --git a/docs/index.md b/docs/index.md
@@ -1,18 +1,6 @@
 # SPACEc
 
-Add a short description here!
-
-
-## Note
-
-> This is the main page of your project's [Sphinx] documentation. It is
-> formatted in [Markdown]. Add additional pages by creating md-files in
-> `docs` or rst-files (formatted in [reStructuredText]) and adding links to
-> them in the `Contents` section below.
->
-> Please check [Sphinx] and [MyST] for more information
-> about how to document your project and how to configure your preferences.
-
+This is SPACEc (SPatial Analysis for CodEX data).
 
 ## Contents