Skip to content

Commit

Permalink
added stuff for docs hosting
Browse files Browse the repository at this point in the history
  • Loading branch information
zsunberg committed Jun 8, 2016
1 parent fcab507 commit 90ab0f4
Show file tree
Hide file tree
Showing 8 changed files with 52 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .gitignore
@@ -1,2 +1,4 @@
*.jl.cov
*.jl.mem
docs/build/
docs/site/
2 changes: 2 additions & 0 deletions .travis.yml
Expand Up @@ -10,3 +10,5 @@ script:
- julia --check-bounds=yes -e 'Pkg.clone("https://github.com/sisl/POMDPs.jl"); Pkg.clone("https://github.com/sisl/POMDPModels.jl"); Pkg.clone("https://github.com/sisl/POMDPDistributions.jl"); Pkg.clone("https://github.com/sisl/POMDPToolbox.jl"); Pkg.clone("https://github.com/JuliaPOMDP/GenerativeModels.jl"); Pkg.clone(pwd()); Pkg.test("MCTS"; coverage=true)'
after_success:
- julia -e 'cd(Pkg.dir("MCTS")); Pkg.add("Coverage"); using Coverage; Coveralls.submit(Coveralls.process_folder())'
- julia -e 'Pkg.clone("https://github.com/JuliaDocs/Documenter.jl")'
- julia -e 'cd(Pkg.dir("MCTS")); include(joinpath("docs", "make.jl"))'
6 changes: 6 additions & 0 deletions docs/make.jl
@@ -1,3 +1,9 @@
using Documenter, MCTS

makedocs()

deploydocs(
repo = "github.com/JuliaPOMDP/MCTS.jl.git"
julia = "release",
osname = "linux"
)
24 changes: 24 additions & 0 deletions docs/mkdocs.yml
@@ -0,0 +1,24 @@
site_name: MCTS.jl
repo_url: https://github.com/JuliaPOMDP/MCTS.jl
site_description: Description...
site_author: USER_NAME

theme: readthedocs

extra_css:
- assets/Documenter.css

extra_javascript:
- https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML
- assets/mathjaxhelper.js

markdown_extensions:
- extra
- tables
- fenced_code
- mdx_math

docs_dir: 'build'

pages:
- Home: index.md
3 changes: 3 additions & 0 deletions docs/src/aggregation.md
@@ -0,0 +1,3 @@
# Aggregating Solver

(No documentation yet)
3 changes: 3 additions & 0 deletions docs/src/dpw.md
@@ -0,0 +1,3 @@
# Double Progressive Widening

(No documentation yet)
9 changes: 9 additions & 0 deletions docs/src/vanilla.md
@@ -0,0 +1,9 @@
# Vanilla

The "vanilla" solver is the most basic version of MCTS. It works well with small discrete state and action spaces.

The solver fields are used to specify solver parameters. All of them can be specified as keyword arguments to the solver constructor.

```@docs
MCTS.MCTSSolver
```
3 changes: 3 additions & 0 deletions docs/src/visualization.md
@@ -0,0 +1,3 @@
# Visualization

(No documentation yet)

0 comments on commit 90ab0f4

Please sign in to comment.