Fixing docs and other cleanups

Author: pjuangph

.gitlab-ci.yml

@@ -3,30 +3,27 @@
 stages:
   - build
   - deploy
-  
+
 job:
     stage: build
-    image: python:3.9
+    image: python:3.11
     script:
-        - sudo yum update -q -y
-        - sudo yum install -y python3-pip
-        - pip uninstall pandas numpy scipy -y -y -y
-        - pip install pandas numpy scipy
-        - pip install setuptools cython
+        - pip install poetry
         - cd python
-        - python3 setup.py install
+        - poetry install --with docs
         - cd ../
     artifacts:
         untracked: true
 
-pages:    
+pages:
   stage: deploy
   script:
+    - pip install poetry
+    - cd python
+    - poetry run sphinx-build -b html ../docs ../docs/_build/html
+    - cd ../
     - mkdir .public
-    - cd python/docs
-    - make html
-    - cd ../../
-    - cp -r python/docs/_build/html/* .public
+    - cp -r docs/_build/html/* .public
     - mv .public public
   artifacts:
     paths:

.readthedocs.yaml

@@ -5,13 +5,15 @@
 # Required
 version: 2
 
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+  jobs:
+    post_install:
+      - pip install poetry
+      - cd python && poetry install --with docs
+
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
   configuration: docs/conf.py
-
-# Optionally set the version of Python and requirements required to build your docs
-python:
-  version: 3.7
-  install:
-    - requirements: docs/requirements.txt
-    - requirements: python/requirements.txt

docs/conf.py

@@ -32,7 +32,7 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
 
-html_theme = 'classic'
+html_theme = 'sphinx_rtd_theme'
 html_static_path = ['_static']
 
 extensions = ['sphinx.ext.autodoc',

docs/notes/installation.rst

@@ -16,5 +16,16 @@ Installation via Pip
 Installation from Source
 -------------------------
 
-Download the git repository and navigate to the python folder where you see setup.py. Run the following command `python setup.py install` and that should install the library in your python environment. 
+Download the git repository and navigate to the ``python`` folder. Install using Poetry:
 
+.. code-block:: none
+
+    cd python
+    poetry install
+
+To also install documentation dependencies:
+
+.. code-block:: none
+
+    cd python
+    poetry install --with docs

python/requirements.txt

@@ -1,7 +1,7 @@
-cython
-bz2file
 tqdm
 scipy
 pandas
 numpy
-matplotlib
+matplotlib
+networkx
+pymetis