Skip to content

Commit 06343f0

Browse files
authored
Add documentation build (#6)
* Add documentation build * Update documentation.yml * Update documentation.yml * Re-resolve for nightly * Update make.jl
1 parent 9afb5c5 commit 06343f0

File tree

3 files changed

+66
-36
lines changed

3 files changed

+66
-36
lines changed
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
name: Documentation
3+
4+
# Cancel in-progress documentation builds as soon as new commits are pushed to
5+
# the same branch to prevent unnecessary builds from clogging up the GitHub
6+
# Actions runner queue.
7+
concurrency:
8+
group: ${{ github.workflow }}-${{ github.ref }}
9+
cancel-in-progress: true
10+
11+
on:
12+
push:
13+
branches:
14+
- 'main'
15+
- 'release-*'
16+
tags:
17+
- 'v*'
18+
pull_request:
19+
20+
# needed to allow julia-actions/cache to delete old caches that it has created
21+
permissions:
22+
actions: write
23+
contents: write
24+
25+
jobs:
26+
test:
27+
runs-on: ubuntu-latest
28+
steps:
29+
- uses: actions/checkout@v4
30+
- uses: julia-actions/setup-julia@v1
31+
with:
32+
version: 'nightly'
33+
arch: x64
34+
- uses: julia-actions/cache@v1
35+
- uses: julia-actions/julia-buildpkg@v1
36+
with:
37+
project: 'docs'
38+
- name: Build and deploy
39+
env:
40+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
41+
run: julia --project=docs/ docs/make.jl

docs/Manifest.toml

Lines changed: 23 additions & 19 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/make.jl

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,7 @@ if !(dirname(@__DIR__) ∈ Base.LOAD_PATH)
33
insert!(Base.LOAD_PATH, 2, dirname(@__DIR__))
44
end
55

6-
using Documenter, Base64
7-
8-
# Normalize the documenter key if it's not already base64-encoded
9-
documenter_key = get(ENV, "DOCUMENTER_KEY", "")
10-
try
11-
base64decode(documenter_key)
12-
catch e
13-
if isa(e, ArgumentError)
14-
if !endswith(documenter_key, "\n")
15-
global documenter_key = string(documenter_key, "\n")
16-
end
17-
ENV["DOCUMENTER_KEY"] = base64encode(documenter_key)
18-
else
19-
rethrow(e)
20-
end
21-
end
6+
using Documenter
227

238
@info("Running any `0_setup.jl` files in the `src/` tree...")
249
# Ensure that we've run any `0_setup.jl` files.
@@ -48,7 +33,7 @@ makedocs(;
4833
)
4934

5035
deploydocs(
51-
repo = "github.com/JuliaComputing/DAECompiler.jl.git",
36+
repo = "github.com/CedarEDA/DAECompiler.jl.git",
5237
branch = "docs",
5338
target = "build",
5439
)

0 commit comments

Comments
 (0)