Skip to content

Commit c11e151

Browse files
committed
add some more docs
1 parent db94903 commit c11e151

File tree

8 files changed

+52
-1
lines changed

8 files changed

+52
-1
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
/.venv/
22
/runs/
3+
/site/

docs/api/Testing/test.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Testing
2+
3+
::: robot_nav.test
4+
options:
5+
show_root_heading: true
6+
show_source: true
7+
8+
::: robot_nav.test_random
9+
options:
10+
show_root_heading: true
11+
show_source: true

docs/api/Testing/testrnn.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Testing RNN
2+
3+
::: robot_nav.test_rnn
4+
options:
5+
show_root_heading: true
6+
show_source: true

docs/api/Training/train.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Training
2+
3+
::: robot_nav.train
4+
options:
5+
show_root_heading: true
6+
show_source: true

docs/api/Training/trainrnn.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Training RNN
2+
3+
::: robot_nav.train_rnn
4+
options:
5+
show_root_heading: true
6+
show_source: true

docs/api/Utils/replay_buffer.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Replay/Rollout Buffer
2+
3+
::: robot_nav.replay_buffer
4+
options:
5+
show_root_heading: true
6+
show_source: true

docs/api/Utils/utils.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Utils
2+
3+
::: robot_nav.utils
4+
options:
5+
show_root_heading: true
6+
show_source: true

mkdocs.yml

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,20 @@ nav:
88
Models:
99
- DDPG: api/models/DDPG.md
1010
- TD3: api/models/TD3.md
11-
- CNNTD3: api/models/cnntd3.md
11+
- CNNTD3: api/models/train.md
1212
- RCPG: api/models/RCPG.md
1313
- HCM: api/models/HCM.md
1414
- PPO: api/models/PPO.md
1515
- SAC: api/models/SAC.md
16+
Training:
17+
- Train: api/Training/train.md
18+
- Train RNN: api/Training/trainrnn.md
19+
Testing:
20+
- Test: api/Training/test.md
21+
- Test RNN: api/Training/testrnn.md
22+
Utils:
23+
- Replay Buffer: api/Utils/replay_buffer.md
24+
- Utils: api/Utils/utils.md
1625
plugins:
1726
- search
1827
- mkdocstrings

0 commit comments

Comments
 (0)