Added .readthedocs.yaml file + updated docs landing page

Fek04 · w1th0utnam3 · commit 3f1955c18166 · 2025-06-11T13:45:48.000+02:00
diff --git a/pysplashsurf/.readthedocs.yaml b/pysplashsurf/.readthedocs.yaml
@@ -0,0 +1,17 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+sphinx:
+  configuration: pysplashsurf/docs/source/conf.py
+
+python:
+  install:
+    - requirements: pysplashsurf/docs/requirements.txt
diff --git a/pysplashsurf/README.md b/pysplashsurf/README.md
@@ -1,4 +1,4 @@
-# Pysplashsurf
+# PySplashsurf
 
 ![splashsurf logo](https://raw.githubusercontent.com/InteractiveComputerGraphics/splashsurf/main/logos/logo_small.svg "splashsurf")
 
diff --git a/pysplashsurf/pysplashsurf/docs/requirements.txt b/pysplashsurf/pysplashsurf/docs/requirements.txt
@@ -1,6 +1,8 @@
 pip==25.0.1
+sphinx==8.2.3
 numpy==2.2.3
 meshio==5.3.5
 sphinx_rtd_theme==3.0.1
 numpydoc==1.8.0
 myst-parser==4.0.1
+pysplashsurf
diff --git a/pysplashsurf/pysplashsurf/docs/source/conf.py b/pysplashsurf/pysplashsurf/docs/source/conf.py
@@ -17,7 +17,7 @@
 
 # -- Project information -----------------------------------------------------
 
-project = 'Pysplashsurf'
+project = 'PySplashsurf'
 copyright = '2025, Interactive Computer Graphics'
 author = 'Interactive Computer Graphics'
 
diff --git a/pysplashsurf/pysplashsurf/docs/source/index.md b/pysplashsurf/pysplashsurf/docs/source/index.md
@@ -0,0 +1,9 @@
+```{include} ../../../README.md
+```
+
+```{toctree}
+:caption: Table of Contents
+methods
+classes
+api
+```
diff --git a/pysplashsurf/pysplashsurf/docs/source/index.rst b/pysplashsurf/pysplashsurf/docs/source/index.rst
diff --git a/pysplashsurf/pysplashsurf/docs/source/introduction.md b/pysplashsurf/pysplashsurf/docs/source/introduction.md

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Pysplashsurf`
	`1`	`+# PySplashsurf`
`2`	`2`
`3`	`3`	`![splashsurf logo](https://raw.githubusercontent.com/InteractiveComputerGraphics/splashsurf/main/logos/logo_small.svg "splashsurf")`
`4`	`4`