Skip to content

Commit

Permalink
- added .readthedocs config file
Browse files Browse the repository at this point in the history
  • Loading branch information
janbender committed Oct 17, 2023
1 parent 99978f7 commit 74eb2ae
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 6 deletions.
35 changes: 35 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -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
9 changes: 3 additions & 6 deletions doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@

.. image:: https://raw.githubusercontent.com/InteractiveComputerGraphics/SPlisHSPlasH/master/doc/images/logo_small.jpg

<br>
An open-source library for the simulation of fluids and solids
<br>
Web page: [https://splishsplash.physics-simulation.org](https://splishsplash.physics-simulation.org/)
<br>
|
| An open-source library for the simulation of fluids and solids
| Web page: https://splishsplash.physics-simulation.org/
.. toctree::
:maxdepth: 2
Expand Down

0 comments on commit 74eb2ae

Please sign in to comment.