Skip to content

Commit b8e9ffd

Browse files
Update docs script for new 'limited' RL.jl release (#1038)
* Update docs script for new 'limited' RL.jl release * Update Project.toml * Drop RLZoo * Drop blog from nav (as not updated) * Drop exp assets * Add RL.jl to docs * Swap out RL.jl in import statement * drop var
1 parent 3cc1ef5 commit b8e9ffd

4 files changed

Lines changed: 4 additions & 37 deletions

File tree

docs/Project.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,10 @@ Pkg = "44cfe95a-1eb2-52ea-b672-e2afdf69b78f"
1818
Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
1919
PyPlot = "d330b81b-6aea-500a-939a-2ce795aea3ee"
2020
Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
21+
ReinforcementLearning = "158674fc-8238-5cab-b5ba-03dfc80d1318"
2122
ReinforcementLearningBase = "e575027e-6cd6-5018-9292-cdc6200d2b44"
2223
ReinforcementLearningCore = "de1b191a-4ae0-4afa-a27b-92d07f46b2d6"
2324
ReinforcementLearningEnvironments = "25e41dd2-4622-11e9-1641-f1adca772921"
24-
ReinforcementLearningZoo = "d607f57d-ee1e-4ba7-bcf2-7734c1e31854"
2525
Setfield = "efcf1570-3423-57d1-acb7-fd33fddbac46"
2626
StableRNGs = "860ef19b-820b-49d6-a774-d7a799459cd3"
2727
Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"

docs/homepage/Project.toml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,3 @@ ReinforcementLearning = "158674fc-8238-5cab-b5ba-03dfc80d1318"
88
ReinforcementLearningBase = "e575027e-6cd6-5018-9292-cdc6200d2b44"
99
ReinforcementLearningCore = "de1b191a-4ae0-4afa-a27b-92d07f46b2d6"
1010
ReinforcementLearningEnvironments = "25e41dd2-4622-11e9-1641-f1adca772921"
11-
ReinforcementLearningZoo = "d607f57d-ee1e-4ba7-bcf2-7734c1e31854"

docs/homepage/_layout/nav.html

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,9 @@
2727
<li class="nav-item">
2828
<a class="nav-link" href="/docs/">Doc</a>
2929
</li>
30-
<li class="nav-item">
31-
<a class="nav-link" href="/blog/">Blog</a>
32-
</li>
3330
<li class="nav-item">
3431
<a class="nav-link" href="https://github.com/JuliaReinforcementLearning">Github</a>
3532
</li>
3633
</ul>
3734
</div>
38-
</nav>
35+
</nav>

docs/make.jl

Lines changed: 2 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
# using ReinforcementLearning
2-
# using ReinforcementLearningDatasets
3-
using ReinforcementLearningCore, ReinforcementLearningBase, ReinforcementLearningZoo, ReinforcementLearningEnvironments
1+
using ReinforcementLearning
42
using Documenter
53
using Markdown
64
using DemoCards
@@ -14,40 +12,20 @@ open(joinpath(@__DIR__, "..", "README.md"), "r") do f_src
1412
end
1513
end
1614

17-
exp_src_dir = joinpath(@__DIR__, "..", "src", "ReinforcementLearningExperiments", "deps", "experiments")
18-
exp_dest_dir = joinpath(@__DIR__, "experiments")
19-
cp(exp_src_dir, exp_dest_dir; force=true)
20-
21-
# TODO: remove this as experiments are updated to run using latest RLCore
22-
# NOTE: config.json needs to be updated as well
23-
rm(joinpath(exp_dest_dir, "experiments", "CFR"), force=true, recursive=true)
24-
rm(joinpath(exp_dest_dir, "experiments", "DQN"), force=true, recursive=true)
25-
rm(joinpath(exp_dest_dir, "experiments", "ED"), force=true, recursive=true)
26-
rm(joinpath(exp_dest_dir, "experiments", "NFSP"), force=true, recursive=true)
27-
rm(joinpath(exp_dest_dir, "experiments", "Offline"), force=true, recursive=true)
28-
rm(joinpath(exp_dest_dir, "experiments", "Policy Gradient"), force=true, recursive=true)
29-
# rm(joinpath(exp_dest_dir, "experiments", "Search"), force=true, recursive=true)
30-
31-
experiments, postprocess_cb, experiments_assets = makedemos("experiments")
32-
3315
assets = [
3416
"assets/favicon.ico",
3517
"assets/custom.css",
36-
experiments_assets
3718
]
3819

3920
makedocs(
4021
modules = [
41-
# ReinforcementLearning,
22+
ReinforcementLearning,
4223
ReinforcementLearningBase,
4324
ReinforcementLearningCore,
4425
ReinforcementLearningEnvironments,
45-
ReinforcementLearningZoo,
46-
# ReinforcementLearningDatasets,
4726
],
4827
format = Documenter.HTML(
4928
prettyurls = true,
50-
analytics = "UA-149861753-1",
5129
assets = assets,
5230
),
5331
sitename = "ReinforcementLearning.jl",
@@ -62,20 +40,13 @@ makedocs(
6240
"Which algorithm should I use?" => "Which_algorithm_should_I_use.md",
6341
"Episodic vs. Non-episodic environments" => "non_episodic.md",
6442
],
65-
"Zoo Algorithms" => [
66-
"MPO" => "Zoo_Algorithms/MPO.md"
67-
],
6843
"FAQ" => "FAQ.md",
69-
experiments,
7044
"Tips for Developers" => "tips.md",
7145
"Manual" => [
7246
"RLBase" => "rlbase.md",
7347
"RLCore" => "rlcore.md",
7448
"RLEnvs" => "rlenvs.md",
75-
"RLZoo" => "rlzoo.md",
76-
"RLDatasets" => "rldatasets.md",
7749
],
7850
]
7951
)
8052

81-
postprocess_cb()

0 commit comments

Comments
 (0)