Readthedocs update

README.md

@@ -4,6 +4,7 @@ SENSE-PPI
 [![DOI - 10.1101/2023.09.19.558413](https://img.shields.io/badge/DOI-10.1101%2F2023.09.19.558413-blue)](https://doi.org/10.1101/2023.09.19.558413)
 [![PyPI](https://img.shields.io/pypi/v/senseppi?logo=PyPi)](https://pypi.org/project/senseppi/)
 [![Licence - MIT](https://img.shields.io/badge/Licence-MIT-2ea44f)](http://gitlab.lcqb.upmc.fr/Konstvv/SENSE-PPI/blob/master/LICENSE)
+[![Documentation Status](https://readthedocs.org/projects/sense-ppi/badge/?version=latest)](https://sense-ppi.readthedocs.io/en/latest/?badge=latest)
 
 SENSE-PPI is a Deep Learning model for predicting physical protein-protein interactions based on amino acid sequences. 
 It is based on embeddings generated by ESM2 and uses Siamese RNN architecture to perform a binary classification.

docs/source/api.rst

-API
-===
-
-.. autosummary::
-   :toctree: generated

docs/source/conf.py

@@ -6,8 +6,8 @@ project = 'SENSE-PPI'
 copyright = '2023, Konstantin Volzhenin, Lucie Bittner, Alessandra Carbone'
 author = 'Konstantin Volzhenin, Lucie Bittner, Alessandra Carbone'
 
-release = '0.1'
-version = '0.1.0'
+release = '0.2'
+version = '0.2.0'
 
 # -- General configuration
 

docs/source/index.rst

@@ -4,10 +4,6 @@ Welcome to SENSE-PPI documentation!
 **SENSE-PPI** is a Deep Learning model for predicting physical protein-protein interactions based on amino acid sequences.
 It is based on embeddings generated by ESM2 and uses Siamese RNN architecture to perform a binary classification.
 
-
-Check out the :doc:`usage` section for further information, including
-how to :ref:`installation` the project.
-
 .. note::
 
    This project is under active development.
@@ -17,5 +13,5 @@ Contents
 
 .. toctree::
 
-   usage
-   api
+    installation
+    usage

docs/source/installation.rst

+Installation
+=====
+
+.. _installation:
+
+To use SENSE-PPI, install it using pip:
+
+.. code-block:: bash
+
+   pip install senseppi
\ No newline at end of file