✨ Readthedocs configuration

Author: Henry

.readthedocs.yaml

@@ -0,0 +1,35 @@
+# .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 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: "19"
+    # rust: "1.64"
+    # golang: "1.19"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# 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:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

README.md

@@ -16,4 +16,12 @@ Install vom [TestPyPI](https://test.pypi.org/project/rasmussenlab-mockup):
 pip install -i https://test.pypi.org/simple/ rasmussenlab-mockup
 ```
 
-> The package on PyPI is call `rasmussenlab-mockup` and not `mockup` as the package name is already taken. The import is still `import mockup`.
+> The package on PyPI is call `rasmussenlab-mockup` and not `mockup` as the package name is already taken. The import is still `import mockup`.
+
+## Readthedocs
+
+The documentation is build using readthedocs automatically. See 
+[project on Readthedocs](https://readthedocs.org/projects/rasmussenlab-python-package/).
+
+- make sure to enable build from PRs in the settings (advanded settings)
+- checkout configuration file: [`.readthedocs.yaml`](.readthedocs.yaml)