Skip to content

Commit

Permalink
documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
dylan-asmar committed May 28, 2022
1 parent 0f508c9 commit 8fe8ea2
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 7 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

[![Build Status](https://github.com/dylan-asmar/TagPOMDPProblem.jl/actions/workflows/BuildStatus.yml/badge.svg)](https://github.com/dylan-asmar/TagPOMDPProblem.jl/actions/workflows/BuildStatus.yml)
[![codecov](https://codecov.io/gh/dylan-asmar/TagPOMDPProblem.jl/branch/main/graph/badge.svg?token=UNYWMYUBDL)](https://codecov.io/gh/dylan-asmar/TagPOMDPProblem.jl)
<!-- [![](https://img.shields.io/badge/docs-stable-blue.svg)](https://dylan-asmar.github.io/TagPOMDPProblem.jl/stable) -->

[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://dylan-asmar.github.io/TagPOMDPProblem.jl/stable)
[![](https://img.shields.io/badge/docs-dev-blue.svg)](https://dylan-asmar.github.io/TagPOMDPProblem.jl/dev)


Expand All @@ -15,10 +16,10 @@ The Tag [1] problem with the [POMDPs.jl](https://github.com/JuliaPOMDP/POMDPs.jl
![Tag Demo](./gifs/tag_SARSOP.gif)

## Installation

Use `]` to get to the package manager to add the package.
```julia
using Pkg
Pkg.add(url="https://github.com/dylan-asmar/TagPOMDPProblem.jl.git")
julia> ]
pkg> add TagPOMDPProblem
```


Expand Down
7 changes: 5 additions & 2 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,15 @@ push!(LOAD_PATH, "../src/")
using Documenter, TagPOMDPProblem

makedocs(
sitename = "TagPOMDPProblem.jl",
authors="Dylan Asmar",
modules = [TagPOMDPProblem],
format = Documenter.HTML(),
sitename = "TagPOMDPProblem.jl",


)

deploydocs(
repo = "github.com/dylan-asmar/TagPOMDPProblem.jl.git"
repo = "github.com/dylan-asmar/TagPOMDPProblem.jl.git",
devbranch = "dev",
)
2 changes: 1 addition & 1 deletion src/tag_types.jl
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ struct TagState
end

"""
TagState
TagGrid
Grid details for the Tag POMDP.
Expand Down

0 comments on commit 8fe8ea2

Please sign in to comment.