Skip to content

Commit

Permalink
Docdeploy action (#3)
Browse files Browse the repository at this point in the history
* use docdeploy action

* point to 'dev' docs rather than 'latest'

* use push previews
  • Loading branch information
ellisbrown authored Jul 15, 2021
1 parent f17f138 commit 41d1e7d
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
11 changes: 5 additions & 6 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ on:
branches: [main]
tags: [v*]
pull_request:

jobs:
build:
name: Documentation
Expand All @@ -13,10 +14,8 @@ jobs:
- uses: julia-actions/setup-julia@latest
with:
version: '1.6'
- name: Install dependencies
run: julia --color=yes --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
- name: Build and deploy
- uses: julia-actions/julia-buildpkg@latest
- uses: julia-actions/julia-docdeploy@latest
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # If authenticating with GitHub Actions token
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # If authenticating with SSH deploy key
run: julia --color=yes --project=docs/ docs/make.jl
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[![codecov](https://codecov.io/gh/JuliaFirstOrder/PiecewiseQuadratics.jl/branch/main/graph/badge.svg?token=DwCCsdwIgc)](https://codecov.io/gh/JuliaFirstOrder/PiecewiseQuadratics.jl)

[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliafirstorder.github.io/PiecewiseQuadratics.jl/stable)
[![](https://img.shields.io/badge/docs-latest-blue.svg)](https://juliafirstorder.github.io/PiecewiseQuadratics.jl/latest)
[![](https://img.shields.io/badge/docs-dev-blue.svg)](https://juliafirstorder.github.io/PiecewiseQuadratics.jl/dev)

**PiecewiseQuadratics.jl** is a [Julia](http://julialang.org) package for manipulation of univariate piecewise quadratic functions of the form
```
Expand Down
1 change: 1 addition & 0 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,5 @@ makedocs(
deploydocs(;
repo = "github.com/JuliaFirstOrder/PiecewiseQuadratics.jl.git",
devbranch = "main",
push_preview = true,
)

0 comments on commit 41d1e7d

Please sign in to comment.