Skip to content

Commit

Permalink
link to travis to generate documentation page (#1)
Browse files Browse the repository at this point in the history
* Create .travis.yml
* Update make.jl
* Update .gitignore
* Update .travis.yml
* Update README.md
  • Loading branch information
gaelforget authored Apr 25, 2019
1 parent 2aa1a30 commit 19de1f8
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 8 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
.DS_Store
devel
docs/build/
11 changes: 11 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
jobs:
include:
- stage: "Documentation"
language: julia
julia: 1.1
os: linux
script:
- julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd()));
Pkg.instantiate()'
- julia --project=docs/ docs/make.jl
after_success: skip
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# CbiomesProcessing.jl

To be continued...
[![](https://img.shields.io/badge/docs-dev-blue.svg)](https://gaelforget.github.io/CbiomesProcessing.jl/dev)

**CbiomesProcessing.jl** provides a simple, distributed workflow to e.g. post-process binary model output. Inter-operability with `MeshArrays.jl` and `NCTiles.jl` is an important prospect of this package.
15 changes: 8 additions & 7 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,16 @@ makedocs(
sitename = "CbiomesProcessing",
format = :html,
modules = [CbiomesProcessing]
pages = Any[
"Home" => "index.md",
"Codes" => "sepdev1.md"
]
)

# pages = Any[
# "Home" => "index.md",
# "Codes" => "sepdev1.md"
# ]

# Documenter can also automatically deploy documentation to gh-pages.
# See "Hosting Documentation" and deploydocs() in the Documenter manual
# for more information.
#=deploydocs(
repo = "<repository url>"
)=#
deploydocs(
repo = "github.com/gaelforget/CBIOMES-Processing.jl.git",
)

0 comments on commit 19de1f8

Please sign in to comment.