docs: add ReadTheDocs configuration; fix mkdocstrings source path

.readthedocs.yaml

@@ -0,0 +1,16 @@
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.12"
+
+mkdocs:
+  configuration: mkdocs.yml
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - doc

CONTRIBUTING.md

@@ -202,6 +202,7 @@ To create a custom workflow, extend `DDMD_manager`:
 ```python
 from ddmd import DDMD_manager
 
+
 class MyWorkflow(DDMD_manager):
     def __init__(self, asyncflow, **kwargs):
         super().__init__(asyncflow)
@@ -212,20 +213,15 @@ class MyWorkflow(DDMD_manager):
         pass
 
     # Implement required abstract methods
-    def stop_simulation(self, prediction):
-        ...
+    def stop_simulation(self, prediction): ...
 
-    async def init_sim_queue(self):
-        ...
+    async def init_sim_queue(self): ...
 
-    async def check_train_data(self):
-        ...
+    async def check_train_data(self): ...
 
-    async def train_model(self):
-        ...
+    async def train_model(self): ...
 
-    async def clean_sim_data(self, sim_ind):
-        ...
+    async def clean_sim_data(self, sim_ind): ...
 ```
 
 ## Questions?

README.md

@@ -114,7 +114,7 @@ class DDMdWrapperWorkflow(BaseWorkflow):
             asyncflow=self.asyncflow,
             config=replica_config_path,
             name=replica_id.replace("_", ""),
-            on_ready=lambda: self._signal_done(),   # ← CM hook
+            on_ready=lambda: self._signal_done(),  # ← CM hook
             policies=self.policies,
             engine_dragon=self.engine_dragon,
         )

mkdocs.yml

@@ -45,7 +45,7 @@ plugins:
   - mkdocstrings:
       handlers:
         python:
-          paths: [src]
+          paths: ["."]
           options:
             docstring_style: google
             show_source: true