docs and readme update

JuliaPOMDP · Dec 11, 2023 · 28eb634 · 28eb634
1 parent 7d338bb
commit 28eb634
Show file tree

Hide file tree

Showing 10 changed files with 25 additions and 29 deletions.
diff --git a/README.md b/README.md
@@ -49,7 +49,7 @@ sim = GifSimulator(;
 simulate(sim, pomdp, policy)
 ```
 
-![Tag Example](./gifs/default.gif)
+![Tag Example](./docs/src/gifs/default.gif)
 
 
 ### Larger Map
@@ -81,7 +81,7 @@ sim = GifSimulator(;
 simulate(sim, pomdp, policy)
 ```
 
-![Tag Larger Map Example](./gifs/larger.gif)
+![Tag Larger Map Example](./docs/src/gifs/larger.gif)
 
 ### Map with Obstacles
 ```julia
@@ -114,4 +114,4 @@ sim = GifSimulator(;
 simulate(sim, pomdp, policy)
 ```
 
-![Obstacle Map Example](./gifs/boundary.gif)
+![Obstacle Map Example](./docs/src/gifs/boundary.gif)
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -1,6 +1,3 @@
 [deps]
-BeliefUpdaters = "8bb6e9a1-7d73-552c-a44a-e5dc5634aac4"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
-POMDPModelTools = "08074719-1b2a-587c-a292-00f91cc44415"
-POMDPs = "a93abf59-7444-517b-a68a-c42f96afdd7d"
-Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
+POMDPTools = "7588e00f-9cae-40de-98dc-e0c70c48cdd7"
diff --git a/docs/make.jl b/docs/make.jl
@@ -2,18 +2,17 @@ using Documenter
 
 push!(LOAD_PATH, "../src/")
 
-using Documenter, TagPOMDPProblem
+using Documenter, TagPOMDPProblem, POMDPTools
 
 makedocs(
     sitename = "TagPOMDPProblem.jl",
     authors="Dylan Asmar",
     modules = [TagPOMDPProblem],
     format = Documenter.HTML(),
-
-
+    doctest=false,
+    checkdocs=:exports
 )
 
 deploydocs(
-    repo = "github.com/dylan-asmar/TagPOMDPProblem.jl.git",
-    devbranch = "dev",
+    repo = "github.com/dylan-asmar/TagPOMDPProblem.jl.git"
 )
diff --git a/gifs/boundary.gif → docs/src/gifs/boundary.gif b/gifs/boundary.gif → docs/src/gifs/boundary.gif
diff --git a/gifs/default.gif → docs/src/gifs/default.gif b/gifs/default.gif → docs/src/gifs/default.gif
diff --git a/gifs/larger.gif → docs/src/gifs/larger.gif b/gifs/larger.gif → docs/src/gifs/larger.gif
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -35,7 +35,7 @@ sim = GifSimulator(;
 simulate(sim, pomdp, policy)
 ```
 
-![Tag Example](../../gifs/default.gif)
+![Tag Example](./gifs/default.gif)
 
 
 ### Larger Map
@@ -67,7 +67,7 @@ sim = GifSimulator(;
 simulate(sim, pomdp, policy)
 ```
 
-![Tag Larger Map Example](../../gifs/larger.gif)
+![Tag Larger Map Example](./gifs/larger.gif)
 
 ### Map with Obstacles
 ```julia
@@ -100,24 +100,24 @@ sim = GifSimulator(;
 simulate(sim, pomdp, policy)
 ```
 
-![Obstacle Map Example](../../gifs/boundary.gif)
+![Obstacle Map Example](./gifs/boundary.gif)
 
 
 # Exported Functions
 ```@docs
-TagPOMDP
 TagPOMDP()
-list_actions()
+POMDPTools.render(::TagPOMDP, ::Any)
+TagPOMDP
 TagState
-POMDPTools.render(TagPOMDP, Any)
 ```
 
 # Internal Functions
 ```@docs
-create_metagraph_from_map()
-map_str_from_metagraph()
-state_from_index()
-modified_transition()
-orig_transition()
-move_direction()
+TagPOMDPProblem.list_actions(::TagPOMDP)
+TagPOMDPProblem.create_metagraph_from_map(::String)
+TagPOMDPProblem.map_str_from_metagraph(::TagPOMDP)
+TagPOMDPProblem.state_from_index(::TagPOMDP, ::Int)
+TagPOMDPProblem.modified_transition(::TagPOMDP, ::TagState, ::Int)
+TagPOMDPProblem.orig_transition(::TagPOMDP, ::TagState, ::Int)
+TagPOMDPProblem.move_direction(::TagPOMDP, ::Int, ::Int)
 ```
diff --git a/scripts/gen_gifs.jl b/scripts/gen_gifs.jl
@@ -18,7 +18,7 @@ sim = GifSimulator(;
     rng=Random.MersenneTwister(1)
 )
 simulate(sim, pomdp, policy)
-mv("default.gif", "gifs/default.gif")
+mv("default.gif", "docs/src/gifs/default.gif")
 
 map_str = """
 xxooooooxxxxxxx
@@ -41,7 +41,7 @@ sim = GifSimulator(;
     rng=Random.MersenneTwister(1)
 )
 simulate(sim, pomdp, policy)
-mv("larger.gif", "gifs/larger.gif")
+mv("larger.gif", "docs/src/gifs/larger.gif")
 
 map_str = """
 xxxxxxxxxx
@@ -65,7 +65,7 @@ sim = GifSimulator(;
     rng=Random.MersenneTwister(1)
 )
 simulate(sim, pomdp, policy)
-mv("boundary.gif", "gifs/boundary.gif")
+mv("boundary.gif", "docs/src/gifs/boundary.gif")
 
 Pkg.rm("SARSOP")
 Pkg.rm("POMDPGifs")

diff --git a/src/TagPOMDPProblem.jl b/src/TagPOMDPProblem.jl
@@ -7,7 +7,7 @@ using MetaGraphs
 using Graphs
 using Plots
 
-export TagPOMDP, TagState, list_actions
+export TagPOMDP, TagState
 
 include("tag_types.jl")
 include("states.jl")

diff --git a/src/visualization.jl b/src/visualization.jl
@@ -10,7 +10,7 @@ respective positions. If the step contains an action, the action will be plotted
 bottom center of the plot. `pre_act_text` can be used to add text before the action text.
 
 - `pomdp::TagPOMDP`: The TagPOMDP to render
-- `step``: Step step to render as a Named Tuple with fields `:b`, `:s`, and `:a`
+- `step`: Step step to render as a Named Tuple with fields `b`, `s`, and `a`
 - `pre_act_text::String`: Text to add before the action text
 """
 function POMDPTools.render(pomdp::TagPOMDP, step; pre_act_text::String="")