Skip to content

Commit

Permalink
added readthedocs.yaml (#6)
Browse files Browse the repository at this point in the history
* Added necessary files for Readthedocs page

* Adjusted docstrings to fit the RTD format

* added short jupyter notebook description

* added configuration file
  • Loading branch information
KonradBreipohl committed Oct 27, 2023
1 parent 26384bf commit 1173a16
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the version of Python and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.11"
apt_packages:
- swig
- r-base

sphinx:
configuration: conf.py

python:
install:
- requirements: rtd_requirements.txt

0 comments on commit 1173a16

Please sign in to comment.