Skip to content

Commit

Permalink
Build docs on GitHub Actions (#6)
Browse files Browse the repository at this point in the history
Also push a preview
  • Loading branch information
timholy authored Dec 24, 2020
1 parent 60085f8 commit 2fd2692
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 2 deletions.
18 changes: 18 additions & 0 deletions .github/workflows/Documenter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Documenter
on:
push:
branches: [master]
tags: [v*]
pull_request:

jobs:
Documenter:
name: Documentation
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: julia-actions/julia-buildpkg@latest
- uses: julia-actions/julia-docdeploy@latest
env:
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
@@ -1,6 +1,6 @@
# TensorCore.jl

[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliahub.com/docs/TensorCore/)
[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://JuliaMath.github.io/TensorCore.jl/stable)
[![CI](https://github.com/JuliaMath/TensorCore.jl/workflows/CI/badge.svg)](https://github.com/JuliaMath/TensorCore.jl/actions?query=workflow%3ACI)
[![Codecov](https://codecov.io/gh/JuliaMath/TensorCore.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/JuliaMath/TensorCore.jl)

Expand Down
2 changes: 1 addition & 1 deletion docs/Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"

[compat]
Documenter = "0.24"
Documenter = "~0.25"
1 change: 1 addition & 0 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,5 @@ makedocs(;

deploydocs(;
repo="github.com/JuliaMath/TensorCore.jl",
push_preview=true
)

2 comments on commit 2fd2692

@timholy
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/26876

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.1.1 -m "<description of version>" 2fd2692476468d08b8cb4caf54b4555c3a4b725a
git push origin v0.1.1

Please sign in to comment.