diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 00000000..cd33f478 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,35 @@ +# Read the Docs configuration file for Sphinx projects +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the OS, Python version and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.11" + # You can also specify other tool versions: + # nodejs: "20" + # rust: "1.70" + # golang: "1.20" + +# Build documentation in the "docs/" directory with Sphinx +sphinx: + configuration: doc/conf.py + # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs + # builder: "dirhtml" + # Fail on all warnings to avoid broken references + # fail_on_warning: true + +# Optionally build your docs in additional formats such as PDF and ePub +# formats: +# - pdf +# - epub + +# Optional but recommended, declare the Python requirements required +# to build your documentation +# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html +python: + install: + - requirements: doc/requirements.txt \ No newline at end of file diff --git a/doc/index.rst b/doc/index.rst index d7ba0aff..3aba0e75 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -1,11 +1,8 @@ .. image:: https://raw.githubusercontent.com/InteractiveComputerGraphics/SPlisHSPlasH/master/doc/images/logo_small.jpg - -
-An open-source library for the simulation of fluids and solids -
-Web page: [https://splishsplash.physics-simulation.org](https://splishsplash.physics-simulation.org/) -
+| +| An open-source library for the simulation of fluids and solids +| Web page: https://splishsplash.physics-simulation.org/ .. toctree:: :maxdepth: 2