Update ReadTheDocs config

Author: w1th0utnam3

pysplashsurf/.readthedocs.yaml

@@ -5,13 +5,19 @@
 version: 2
 
 build:
-  os: ubuntu-22.04
+  os: ubuntu-24.04
   tools:
-    python: "3.12"
+    python: "mambaforge-23.11"
+  jobs:
+    pre_build:
+      - asdf install rust 1.89.0
+      - asdf global rust 1.89.0
+      - py=$(which python) && base="${py%python}" && export LD_LIBRARY_PATH="$LD_LIBRARY_PATH:${base}../lib" && cd pysplashsurf && cargo run --bin stub_gen --no-default-features
+      - cd pysplashsurf && maturin build
+      - pip install target/wheels/*.whl
 
 sphinx:
   configuration: pysplashsurf/pysplashsurf/docs/source/conf.py
 
-python:
-  install:
-    - requirements: pysplashsurf/pysplashsurf/docs/requirements.txt
+conda:
+  environment: pysplashsurf/python_environment.yaml

pysplashsurf/build.rs

@@ -1,5 +1,5 @@
 fn main() {
-    // Required to run cargo check or stub gen outside of maturing build
+    // Required to run cargo check or stub gen outside maturin build
     if std::env::var_os("CARGO_CFG_TARGET_OS=macos").is_some() {
         pyo3_build_config::get()
             .lib_dir

pysplashsurf/pysplashsurf/docs/requirements.txt

@@ -6,4 +6,3 @@ sphinx_rtd_theme==3.0.1
 numpydoc==1.8.0
 myst-parser==4.0.1
 sphinx-autodoc-typehints==3.2.0
-pysplashsurf

pysplashsurf/pysplashsurf/docs/source/conf.py

@@ -6,27 +6,29 @@
 
 # -- Path setup --------------------------------------------------------------
 
-# If extensions (or modules to document with autodoc) are in another directory,
-# 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 os
 import sys
 
 from sphinx.ext.autodoc.importer import import_module
-print(f"### Appended path: {os.path.abspath('../../')}")
-sys.path.insert(0, os.path.abspath('../../'))
-pysplashsurf = import_module('pysplashsurf')
+
+# Verify that the generated stub file exists
+stub_path = os.path.abspath("../../pysplashsurf.pyi")
+if not os.path.exists(stub_path):
+   print(f"### Error: Stub file not found at {stub_path}. Please ensure stub_gen produced pysplashsurf.pyi.")
+   sys.exit(1)
+
+# Import the stub file
+print(f"### Prepend to path: {os.path.abspath('../../')}")
+sys.path.insert(0, os.path.abspath("../../"))
+pysplashsurf = import_module("pysplashsurf")
 
 #import pysplashsurf
 
 # -- Project information -----------------------------------------------------
 
-project = 'pySplashsurf'
-copyright = '2025, Interactive Computer Graphics'
-author = 'Interactive Computer Graphics'
+project = "pySplashsurf"
+copyright = "2025, Interactive Computer Graphics"
+author = "Interactive Computer Graphics"
 
 
 # -- General configuration ---------------------------------------------------
@@ -35,21 +37,21 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-   'sphinx.ext.autodoc',
-   'sphinx.ext.autosummary',
-   'sphinx.ext.napoleon',
-   'numpydoc',
-   'myst_parser',
-   'sphinx_rtd_theme',
-   #'sphinx_autodoc_typehints'
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.napoleon",
+    "numpydoc",
+    "myst_parser",
+    "sphinx_rtd_theme",
+    #'sphinx_autodoc_typehints'
 ]
 
-source_suffix = ['.rst', '.md']
+source_suffix = [".rst", ".md"]
 
 numpydoc_class_members_toctree = False
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -62,7 +64,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'sphinx_rtd_theme'
+html_theme = "sphinx_rtd_theme"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
@@ -73,7 +75,7 @@
 
 always_document_param_types = True
 always_use_bars_union = True
-#typehints_document_rtype = False
-#typehints_use_rtype = False
-#typehints_use_signature = True
-#typehints_use_signature_return = True
+# typehints_document_rtype = False
+# typehints_use_rtype = False
+# typehints_use_signature = True
+# typehints_use_signature_return = True

pysplashsurf/python_environment.yaml

@@ -6,17 +6,21 @@ channels:
   - conda-forge
 dependencies:
   - maturin=1.8.2
+  - patchelf=0.17.2
   - meshio=5.3.5
   - numpy=2.2.3
   - pip=25.0.1
   - python=3.13.2
   - python_abi=3.13
-  - sphinx=8.2.3
   - numpydoc=1.8.0
   - trimesh=4.6.5
   - rtree=1.4.0
   - scipy=1.15.2
-  - sphinx_rtd_theme=3.0.1
-  - myst-parser=4.0.1
   - pytest=8.3.5
   - pytest-md=0.2.0
+
+  - sphinx=8.2.3
+  - sphinx_rtd_theme=3.0.1
+  - myst-parser=4.0.1
+  - numpydoc==1.8.0
+  - sphinx-autodoc-typehints==3.2.0