[Bugfix] Fixes readthedocs configuration

.github/workflows/pytest-ubuntu.yml

@@ -10,6 +10,10 @@ on:
   pull_request:
     branches: [ master ]
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
 jobs:
   tests:
     name: Run tests/coverage

.readthedocs.yml

@@ -4,6 +4,11 @@
 # Required
 version: 2
 
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.12"
+
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
   configuration: docs/conf.py
@@ -15,9 +20,6 @@ sphinx:
 # Optionally build your docs in additional formats such as PDF and ePub
 formats: all
 
-# Optionally set the version of Python and requirements required to build your docs
 python:
-  version: 3.7
   install:
-    - requirements: docs/requirements.txt
-    - requirements: requirements.txt
+    - requirements: docs/requirements.txt

docs/conf.py

@@ -10,7 +10,6 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-import stanford_theme
 import os
 import sys
 sys.path.insert(0, os.path.abspath('..'))
@@ -20,11 +19,11 @@
 # -- Project information -----------------------------------------------------
 
 project = 'desolver'
-copyright = '2021, Ekin Ozturk'
+copyright = '2025, Ekin Ozturk'
 author = 'Ekin Ozturk'
 
 # The full version, including alpha/beta/rc tags
-release = '4.4.1'
+release = '5.0.0'
 
 
 # -- General configuration ---------------------------------------------------
@@ -35,9 +34,9 @@
 extensions = [
     "sphinx.ext.autosectionlabel",
     "nbsphinx",
+    'sphinx.ext.autodoc',
     "sphinx.ext.napoleon",
     'sphinx.ext.mathjax',
-    'sphinx.ext.githubpages',
     'IPython.sphinxext.ipython_console_highlighting',
 #     "sphinx.ext.intersphinx" 
 ]
@@ -60,9 +59,18 @@
 on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
 
 if not on_rtd:  # only import and set the theme if we're building docs locally
-    import stanford_theme
+    import sphinx_theme
     html_theme = 'stanford_theme'
-    html_theme_path = [stanford_theme.get_html_theme_path()]
+    html_theme_path = [sphinx_theme.get_html_theme_path('stanford-theme')]
+else:
+    html_theme_options = {
+        "page_width": "980px",
+        "sidebar_width": "180px",
+        "codecov_button": "true",
+        "github_button": "true",
+        "github_repo": "desolver",
+        "github_user": "microno95"
+    }
 
 # otherwise, readthedocs.org uses their theme by default, so no need to specify it
 

docs/installation.rst

@@ -5,7 +5,7 @@ Installing desolver
 
 `desolver` is a pure python module that builds upon the functionalities provided by numpy for a relatively efficient numerical integration library.
 
-Furthermore, as `desolver` relies on `autoray <https://github.com/jcmgray/autoray>` for the backend of array/tensors operations, `desolver` can easily extend to the use of other libraries such as pytorch, tensorflow, etc. in order to leverage accelerators and optimised gradient computation schemes for faster numerical integration.
+Furthermore, as `desolver` relies on `autoray <https://github.com/jcmgray/autoray>`_ for the backend of array/tensors operations, `desolver` can easily extend to the use of other libraries such as pytorch, tensorflow, etc. in order to leverage accelerators and optimised gradient computation schemes for faster numerical integration.
 
 With the use of libraries equipped with automatic differentiation, it is possible to compute the gradients of the integrated system.
 

docs/requirements.txt

@@ -1,11 +1,9 @@
-scipy>=1.4.1
-numpy>=1.18.0
-coverage
-pytest>=5.4.3
-pytest-cov>=2.10.0
-pytest-xdist>=1.32.0
+numpy>=2
 tqdm>=4.47.0
-stanford_theme
+scipy>=1.4.1
+autoray>=0.7.0
+einops>=0.8.0
+sphinx_theme
 nbsphinx
 ipython
 pandoc>=1.0.2