From 797548d1f4c68db15ee2bfbfa762b119d947234f Mon Sep 17 00:00:00 2001 From: Zewen Kelvin Tuong Date: Tue, 21 Nov 2023 13:08:48 +1000 Subject: [PATCH] Update README.rst (#45) * Update README.rst * fix test --- .readthedocs.yaml | 9 +++++++-- README.rst | 8 +++++++- docs/README.rst | 8 +++++++- 3 files changed, 21 insertions(+), 4 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 236c1dc..b2103f1 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -5,6 +5,12 @@ # 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 @@ -12,10 +18,9 @@ sphinx: # 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 index ab7a810..ec7a192 100644 --- 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 `__. preprint arXiv:2311.04567. 2023 Nov 8. + +as well, as github repositories. Also leave a star at the `ktplotspy `__ and the original `ktplots `__ repositories! diff --git a/docs/README.rst b/docs/README.rst index dcda4f8..5ae5d5a 100644 --- 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 `__. preprint arXiv:2311.04567. 2023 Nov 8. + +as well, as github repositories. Also leave a star at the `ktplotspy `__ and the original `ktplots `__ repositories!