Merge pull request #6 from reiniscimurs/feature/add_docs

Add docs

Author: reiniscimurs

docs/api/models/DDPG.md

@@ -0,0 +1,6 @@
+# DDPG
+
+::: robot_nav.models.DDPG.DDPG
+    options:
+      show_root_heading: true
+      show_source: true

docs/api/models/HCM.md

@@ -0,0 +1,6 @@
+# Hardcoded Model
+
+::: robot_nav.models.HCM.hardcoded_model
+    options:
+      show_root_heading: true
+      show_source: true

docs/api/models/PPO.md

@@ -0,0 +1,6 @@
+# PPO
+
+::: robot_nav.models.PPO.PPO
+    options:
+      show_root_heading: true
+      show_source: true

docs/api/models/RCPG.md

@@ -0,0 +1,6 @@
+# RCPG
+
+::: robot_nav.models.RCPG.RCPG
+    options:
+      show_root_heading: true
+      show_source: true

docs/api/models/SAC.md

@@ -0,0 +1,21 @@
+# SAC
+
+::: robot_nav.models.SAC.SAC
+    options:
+      show_root_heading: true
+      show_source: true
+
+::: robot_nav.models.SAC.SAC_actor
+    options:
+      show_root_heading: true
+      show_source: true
+
+::: robot_nav.models.SAC.SAC_critic
+    options:
+      show_root_heading: true
+      show_source: true
+
+::: robot_nav.models.SAC.SAC_utils
+    options:
+      show_root_heading: true
+      show_source: true

docs/api/models/TD3.md

@@ -0,0 +1,6 @@
+# TD3
+
+::: robot_nav.models.TD3.TD3
+    options:
+      show_root_heading: true
+      show_source: true

docs/api/models/__init__.md

@@ -0,0 +1,7 @@
+# __init__
+
+## Documentation
+
+```
+No documentation available for __init__.
+```

docs/api/models/cnntd3.md

@@ -0,0 +1,6 @@
+# CNNTD3
+
+::: robot_nav.models.CNNTD3.CNNTD3
+    options:
+      show_root_heading: true
+      show_source: true

docs/api/robot_nav.md

@@ -0,0 +1,8 @@
+# Robot Navigation
+
+Will be updated
+
+::: robot_nav
+    options:
+      show_root_heading: true
+      show_source: true

docs/index.md

@@ -0,0 +1,4 @@
+# Welcome to DRL-robot-navigation-IR-SIM
+
+Deep Reinforcement Learning algorithm implementation for simulated robot navigation in IR-SIM. Using 2D laser sensor data
+and information about the goal point a robot learns to navigate to a specified point in the environment.