Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Work on deploying docs via github actions #72

Merged
merged 3 commits into from
Mar 24, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions .github/workflows/UnitTests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,20 @@ jobs:
name: codecov-umbrella
fail_ci_if_error: false
token: ${{ secrets.CODECOV_TOKEN }}
docs:
name: Documentation
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: julia-actions/setup-julia@latest
with:
version: '1'
- run: |
julia --project=docs -e '
using Pkg
Pkg.develop(PackageSpec(path=pwd()))
Pkg.instantiate()'
- run: julia --project=docs docs/make.jl
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
7 changes: 7 additions & 0 deletions docs/Project.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
Automa = "67c07d97-cdcb-5c2c-af73-a7f9c32a568b"

[compat]
Documenter = "0.24 - 0.26"
Automa = "0.9"
9 changes: 4 additions & 5 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,18 @@ using Automa
# run(`julia preconditions.jl`)

makedocs(
format = :html,
sitename = "Automa.jl",
modules = [Automa],
pages = [
"Home" => "index.md",
"References" => "references.md"
]
],
format = Documenter.HTML(
prettyurls = get(ENV, "CI", nothing) == "true")
)

deploydocs(
repo = "github.com/BioJulia/Automa.jl.git",
julia = "0.6",
target = "build",
deps = nothing,
make = nothing
push_preview = true,
)