Skip to content

Commit

Permalink
try gh actions deployment for docs
Browse files Browse the repository at this point in the history
  • Loading branch information
joshday committed Oct 5, 2020
1 parent 91b8119 commit 12d9301
Show file tree
Hide file tree
Showing 5 changed files with 52 additions and 9 deletions.
24 changes: 24 additions & 0 deletions .github/workflows/Documenter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Documentation

on:
push:
branches:
- master
tags: '*'
pull_request:

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: julia-actions/setup-julia@latest
with:
version: '1.4'
- name: Install dependencies
run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
- name: Build and deploy
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # For authentication with GitHub Actions token
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # For authentication with SSH deploy key
run: julia --project=docs/ docs/make.jl
3 changes: 2 additions & 1 deletion .github/workflows/TagBot.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
name: TagBot
on:
schedule:
- cron: 0 * * * *
- cron: 0 0 * * *
jobs:
TagBot:
runs-on: ubuntu-latest
steps:
- uses: JuliaRegistries/TagBot@v1
with:
token: ${{ secrets.GITHUB_TOKEN }}
ssh: ${{ secrets.DOCUMENTER_KEY }}
8 changes: 0 additions & 8 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,3 @@ after_success:
jobs:
allow_failures:
- julia: nightly
include:
- stage: "Documentation"
julia: 1.4
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
13 changes: 13 additions & 0 deletions docs/src/bivariate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Bivariate Example


```@example
using AverageShiftedHistograms, Plots
x = randn(10_000)
y = x + randn(10_000)
o = ash(x, y)
plot(o)
```
13 changes: 13 additions & 0 deletions docs/src/univariate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Univariate Example

```@example
using AverageShiftedHistograms, Plots
y = randn(100_000)
o = ash(y; rng = -5:.2:5)
xy(o) # return (rng, density)
plot(plot(o), plot(o; hist=false), layout=(2,1))
```

0 comments on commit 12d9301

Please sign in to comment.