update readthedocs

docs/source/conf.py

@@ -25,7 +25,8 @@
     "sphinx.ext.mathjax",
     "sphinx.ext.viewcode",
     "sphinx.ext.doctest",
-    "sphinx_rtd_theme"
+    "sphinx_rtd_theme",
+    "sphinxcontrib.bibtex",
 ]
 
 bibtex_bibfiles = ['refs.bib']

docs/source/index.rst

@@ -19,10 +19,13 @@ Rxn-INSIGHT can be installed from PyPI using pip (on python 3.10 or 3.11):
 
 Please cite the Rxn-INSIGHT paper, if you use it in your own work.
 
+.. footbibliography::
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents
 
+   installation
    modules
 
 

docs/source/installation.rst

@@ -0,0 +1,32 @@
+.. _installation:
+
+Installation
+============
+
+Rxn-INSIGHT can be installed from PyPI via pip or directly from the GitHub repository.
+
+Option 1: Installing from PyPI using pip
+----------------------------------------
+.. code-block::
+
+    conda create -n rxn-insight python=3.11
+    conda activate rxn-insight
+    pip install rxn-insight
+
+.. note::
+    Currently only python 3.10 and python 3.11 are supported.
+
+Option 2: Installing from source using pip
+------------------------------------------
+.. code-block::
+
+    conda create -n rxn-insight python=3.11
+    conda activate rxn-insight
+    git clone https://github.com/mrodobbe/Rxn-INSIGHT.git
+    cd Rxn-INSIGHT
+    pip install -e .
+
+.. note::
+    You can also use this option to install additional optional dependencies for development purposes,
+    which are required to run the tests and build the docs by running ``pip install -e ".[test,doc]"``.
+

pyproject.toml

@@ -19,6 +19,7 @@ dependencies = [
     "openpyxl",
     "ipykernel",
     "sphinx-rtd-theme",
+    "sphinxcontrib-bibtex",
 ]
 authors = [
     {name = "Maarten R. Dobbelaere", email = "mrodobbe.dobbelaere@ugent.be"}
@@ -40,7 +41,7 @@ dynamic = ["version"]
 [project.urls]
 source = "https://github.com/mrodobbe/rxn-insight"
 tracker = "https://github.com/mrodobbe/rxn-insight/issues"
-# documentation = "https://rxn-insight.readthedocs.io"
+documentation = "https://rxn-insight.readthedocs.io"
 
 [project.optional-dependencies]
 test = [