Update README.rst (#45)

* Update README.rst * fix test
zktuong · Nov 21, 2023 · 797548d · 797548d
1 parent be4ffc2
commit 797548d
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 4 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -5,17 +5,22 @@
 # Required
 version: 2
 
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
   configuration: docs/conf.py
 
 # Build documentation with MkDocs
 #mkdocs:
 #  configuration: mkdocs.yml
-  
+
 # Optionally set the version of Python and requirements required to build your docs
 python:
-  version: 3.8
   install:
     - method: pip
       path: .

diff --git a/README.rst b/README.rst
@@ -34,7 +34,13 @@ post in the issue tracker and I will get back to you.
 Citation
 --------
 
-If you find this useful, please consider citing the github repositories. Also leave a star at the 
+If you find this useful, please cite the following preprint:
+
+.. [Troule2023]  Troulé K, Petryszak R, Prete M, Cranley J, Harasty A, Tuong ZK, Teichmann SA, Garcia-Alonso L, Vento-Tormo R. (2023)
+   *CellPhoneDB v5: inferring cell-cell communication from single-cell multiomics data.*,
+   `arXiv <https://arxiv.org/abs/2311.04567>`__. preprint arXiv:2311.04567. 2023 Nov 8. 
+
+as well, as github repositories. Also leave a star at the 
 `ktplotspy <https://www.github.com/zktuong/ktplotspy/>`__ and the original
 `ktplots <https://www.github.com/zktuong/ktplots/>`__ repositories!
 

diff --git a/docs/README.rst b/docs/README.rst
@@ -30,7 +30,13 @@ post in the issue tracker and I will get back to you.
 Citation
 --------
 
-If you find this useful, please consider citing the github repositories. Also leave a star at the 
+If you find this useful, please cite the following preprint:
+
+.. [Troule2023]  Troulé K, Petryszak R, Prete M, Cranley J, Harasty A, Tuong ZK, Teichmann SA, Garcia-Alonso L, Vento-Tormo R. (2023)
+   *CellPhoneDB v5: inferring cell-cell communication from single-cell multiomics data.*,
+   `arXiv <https://arxiv.org/abs/2311.04567>`__. preprint arXiv:2311.04567. 2023 Nov 8. 
+
+as well, as github repositories. Also leave a star at the 
 `ktplotspy <https://www.github.com/zktuong/ktplotspy/>`__ and the original
 `ktplots <https://www.github.com/zktuong/ktplots/>`__ repositories!