Skip to content

Commit 179788f

Browse files
committed
cleanup doc generation
1 parent 6eb5f5f commit 179788f

File tree

2 files changed

+28
-1
lines changed

2 files changed

+28
-1
lines changed

.github/workflows/documentation.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# see https://juliadocs.github.io/Documenter.jl/dev/man/hosting/#GitHub-Actions
2+
# add this file to the repository once you set up authentication as described in the Documenter manual
3+
4+
name: Documentation
5+
6+
on:
7+
push:
8+
branches:
9+
- master
10+
tags: '*'
11+
pull_request:
12+
13+
jobs:
14+
build:
15+
runs-on: ubuntu-latest
16+
steps:
17+
- uses: actions/checkout@v4
18+
- uses: julia-actions/setup-julia@latest
19+
with:
20+
version: '1.10'
21+
- name: Install dependencies
22+
run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
23+
- name: Build and deploy
24+
env:
25+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # If authenticating with GitHub Actions token
26+
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # If authenticating with SSH deploy key
27+
run: julia --project=docs/ docs/make.jl

docs/Project.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
33
NLopt = "76087f3c-5699-56af-9a33-bf431cd00edd"
44

55
[compat]
6-
Documenter = "~0.26"
6+
Documenter = "1"

0 commit comments

Comments
 (0)