From 54305e8214658fd21dc4aed237416214d6bc1807 Mon Sep 17 00:00:00 2001
From: JustaGist <saifksidhik@gmail.com>
Date: Wed, 7 Aug 2024 15:16:43 +0100
Subject: [PATCH] add .readthedocs.yaml

---
 .readthedocs.yaml | 32 ++++++++++++++++++++++++++++++++
 README.md         |  2 ++
 pixi.lock         |  2 +-
 pyproject.toml    |  1 -
 4 files changed, 35 insertions(+), 2 deletions(-)
 create mode 100644 .readthedocs.yaml

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
new file mode 100644
index 0000000..eecdd79
--- /dev/null
+++ b/.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: docs/requirements.txt
+    - method: pip
+      path: .
+      extra_requirements:
+        - full
\ No newline at end of file
diff --git a/README.md b/README.md
index babcada..da57a2c 100644
--- a/README.md
+++ b/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)
diff --git a/pixi.lock b/pixi.lock
index 8064f65..45050b1 100644
--- a/pixi.lock
+++ b/pixi.lock
@@ -1830,7 +1830,7 @@ packages:
   name: pyrcf
   version: 0.0.4
   path: .
-  sha256: 3bba2a5ab04ef7891993cd9e5d5426842692ec73b74250991e0420a0e9e5e1d9
+  sha256: 99d59bb4deb6ff99fe7ba8d13db0d5303eb4eefeb8d6cc1fc442e35499043d5b
   requires_dist:
   - pybullet>=3.2.6,<4
   - pin>=2.7.0,<3
diff --git a/pyproject.toml b/pyproject.toml
index c836e3e..b6f4375 100644
--- a/pyproject.toml
+++ b/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" }