add .readthedocs.yaml

.readthedocs.yaml

@@ -0,0 +1,32 @@
+# .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.12"
+
+# 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:
+    - requirements: requirements/docs.txt
+    - method: pip
+      path: .
+      extra_requirements:
+        - full

README.md

@@ -2,6 +2,7 @@
 
 [![Python](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12-blue)](https://www.python.org/downloads/)
 [![GitHub release](https://img.shields.io/github/release/justagist/pyrcf.svg)](https://github.com/justagist/pyrcf/releases/)
+[![Documentation Status](https://readthedocs.org/projects/pyrcf/badge/?version=latest)](https://pyrcf.readthedocs.io/en/latest/?badge=latest)
 [![License](https://img.shields.io/pypi/l/bencher)](https://opensource.org/license/mit/)
 
 A Python Robot Control Framework for quickly prototyping control algorithms for different robot embodiments.
@@ -94,4 +95,5 @@ More complex algorithms for control and planning will be provided by this packag
 
 Tutorials and more details about concepts will be provided soon in the [tutorials](examples/tutorials) folder.
 
+[![Documentation Status](https://readthedocs.org/projects/pyrcf/badge/?version=latest)](https://pyrcf.readthedocs.io/en/latest/?badge=latest)
 [![Pixi Badge](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/prefix-dev/pixi/main/assets/badge/v0.json)](https://pixi.sh)

pyproject.toml

@@ -61,7 +61,6 @@ docs = ["sphinxcontrib-napoleon", "sphinx-rtd-theme", "sphinx-autoapi"]
 Source = "https://github.com/justagist/pyrcf"
 Home = "https://github.com/justagist/pyrcf"
 
-
 # Environments
 [tool.pixi.environments]
 default = { features = ["test", "docs"], solve-group = "default" }