Update docs to incorporate POMDPExamples and POMDPGallery

README.md

@@ -89,17 +89,15 @@ end
 println("Undiscounted reward was $rsum.")
 ```
 
-For more examples with visualization, see the documentation below and [POMDPGallery.jl](https://github.com/JuliaPOMDP/POMDPGallery.jl).
+For more examples and examples with visualizations, reference the [Examples](https://JuliaPOMDP.github.io/POMDPs.jl/latest/examples) and [Gallery of POMDPs.jl Problems](https://JuliaPOMDP.github.io/POMDPs.jl/latest/gallery) sections of the documentaiton.
 
 ## Documentation and Tutorials
 
-In addition to the above-mentioned [Julia Academy course](https://juliaacademy.com/p/decision-making-under-uncertainty-with-pomdps-jl), detailed documentation can be found [here](http://juliapomdp.github.io/POMDPs.jl/stable/).
+In addition to the above-mentioned [Julia Academy course](https://juliaacademy.com/p/decision-making-under-uncertainty-with-pomdps-jl), detailed documentation and examples can be found [here](http://juliapomdp.github.io/POMDPs.jl/stable/).
 
 [![Docs](https://img.shields.io/badge/docs-stable-blue.svg)](https://JuliaPOMDP.github.io/POMDPs.jl/stable)
 [![Docs](https://img.shields.io/badge/docs-latest-blue.svg)](https://JuliaPOMDP.github.io/POMDPs.jl/latest)
 
-Several tutorials are hosted in the [POMDPExamples repository](https://github.com/JuliaPOMDP/POMDPExamples.jl).
-
 
 ## Supported Packages
 

docs/Project.toml

@@ -1,12 +1,29 @@
 [deps]
+BasicPOMCP = "d721219e-3fc6-5570-a8ef-e5402f47c49e"
+Cairo = "159f3aea-2a34-519c-b102-8c37f9878175"
+Compose = "a81c6b42-2e10-5240-aca2-a61377ecd94b"
+DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
+DiscreteValueIteration = "4b033969-44f6-5439-a48b-c11fa3648068"
 Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+DroneSurveillance = "63556450-714a-11e9-08e1-e368b701e279"
+Fontconfig = "186bb1d3-e1f7-5a2c-a377-96d770f13627"
 LightGraphs = "093fc24a-ae57-5d10-9952-331d41423f4d"
+MCTS = "e12ccd36-dcad-5f33-8774-9175229e7b33"
 NamedTupleTools = "d9ec5142-1e00-5aa0-9d6a-321866360f50"
+NativeSARSOP = "a07c76ea-660d-4c9a-8028-2e6dbd212cb8"
+POMDPGifs = "7f35509c-0cb9-11e9-0708-2928828cdbb7"
+POMDPLinter = "f3bd98c0-eb40-45e2-9eb1-f2763262d755"
 POMDPModels = "355abbd5-f08e-5560-ac9e-8b5f2592a0ca"
 POMDPTools = "7588e00f-9cae-40de-98dc-e0c70c48cdd7"
 POMDPs = "a93abf59-7444-517b-a68a-c42f96afdd7d"
+ParticleFilters = "c8b314e2-9260-5cf8-ae76-3be7461ca6d0"
+QMDP = "3aa3ecc9-5a5d-57c8-8188-3e47bd8068d2"
 QuickPOMDPs = "8af83fb2-a731-493c-9049-9e19dbce6165"
+RockSample = "de008ff0-c357-11e8-3329-7fe746fe836e"
+StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"
+TagPOMDPProblem = "8a653263-a1cc-4cf9-849f-f530f6ffc800"
+UnicodePlots = "b8865327-cd53-5732-bb35-84acbb429228"
 
 [compat]
 Documenter = "1"

docs/make.jl

@@ -37,6 +37,15 @@ makedocs(
             "run_simulation.md",
             "policy_interaction.md"
            ],
+
+        "Examples and Gallery" => [
+            "examples.md",
+            "example_defining_problems.md",
+            "example_solvers.md",
+            "example_simulations.md",
+            "example_gridworld_mdp.md",
+            "gallery.md"
+           ],
 
         "POMDPTools" => [
             "POMDPTools/index.md",
@@ -59,4 +68,5 @@ makedocs(
 
 deploydocs(
     repo = "github.com/JuliaPOMDP/POMDPs.jl.git",
+    push_preview=true
 )

docs/src/POMDPTools/simulators.md

@@ -2,7 +2,7 @@
 
 POMDPTools contains a collection of POMDPs.jl simulators.
 
-Usage examples can be found in the [simulation tutorial in the POMDPExamples package](https://github.com/JuliaPOMDP/POMDPExamples.jl/blob/master/notebooks/Running-Simulations.ipynb).
+Usage examples can be found in the [Simulations Examples](@ref) section.
 
 If you are just getting started, probably the easiest way to begin is the [`stepthrough` function](@ref Stepping-through). Otherwise, consult the [Which Simulator Should I Use?](@ref which_simulator) guide below:
 
@@ -51,8 +51,6 @@ for (s, a, o, r) in stepthrough(pomdp, policy, "s,a,o,r", max_steps=10)
 end
 ```
 
-More examples can be found in the [POMDPExamples Package](https://github.com/JuliaPOMDP/POMDPExamples.jl/blob/master/notebooks/Running-Simulations.ipynb).
-
 ```@docs
 stepthrough
 ```
@@ -77,8 +75,6 @@ policy = RandomPolicy(mdp)
 r = simulate(rs, mdp, policy)
 ```
 
-More examples can be found in the [POMDPExamples Package](https://github.com/JuliaPOMDP/POMDPExamples.jl/blob/master/notebooks/Running-Simulations.ipynb)
-
 ```@docs
 RolloutSimulator
 ```
@@ -95,8 +91,6 @@ policy = RandomPolicy(pomdp)
 h = simulate(hr, pomdp, policy)
 ```
 
-More examples can be found in the [POMDPExamples Package](https://github.com/JuliaPOMDP/POMDPExamples.jl/blob/master/notebooks/Running-Simulations.ipynb).
-
 ```@docs
 HistoryRecorder
 ```
@@ -116,10 +110,6 @@ This allows a flexible and general way to interact with a POMDP environment with
 
 In the POMDP case, an updater can optionally be supplied as an additional positional argument if the policy function works with beliefs rather than directly with observations.
 
-More examples can be found in the [POMDPExamples Package](https://github.com/JuliaPOMDP/POMDPExamples.jl/blob/master/notebooks/Running-Simulations.ipynb)
-
-More examples can be found in the [POMDPExamples Package](https://github.com/JuliaPOMDP/POMDPExamples.jl/blob/master/notebooks/Running-Simulations.ipynb)
-
 ```@docs
 sim
 ```
@@ -197,7 +187,7 @@ POMDPTools contains a utility for running many Monte Carlo simulations in parall
 
 ### Example
 
-An example can be found in the [POMDPExamples Package](https://github.com/JuliaPOMDP/POMDPExamples.jl/blob/master/notebooks/Running-Simulations.ipynb).
+An example can be found in the [Parallel Simulations](@ref) section.
 
 ### Sim objects