Skip to content

Commit f84d4f8

Browse files
authored
Update docs make.jl and add CI script (#167)
* Update docs make.jl and add CI script * Add autodocs
1 parent c044265 commit f84d4f8

File tree

4 files changed

+46
-4
lines changed

4 files changed

+46
-4
lines changed

.github/workflows/docs.yml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Documentation
2+
on:
3+
push:
4+
branches:
5+
- master
6+
tags: '*'
7+
paths-ignore:
8+
- 'LICENSE.md'
9+
- 'README.md'
10+
- '.github/workflows/TagBot.yml'
11+
pull_request:
12+
paths-ignore:
13+
- 'LICENSE.md'
14+
- 'README.md'
15+
- '.github/workflows/TagBot.yml'
16+
17+
jobs:
18+
docs:
19+
name: Documentation
20+
runs-on: ubuntu-latest
21+
steps:
22+
- uses: actions/checkout@v3
23+
- uses: julia-actions/setup-julia@v1
24+
with:
25+
version: '1'
26+
- run: |
27+
julia --project=docs -e '
28+
using Pkg
29+
Pkg.develop(PackageSpec(; path=pwd()))
30+
Pkg.instantiate()'
31+
- run: julia --project=docs docs/make.jl
32+
env:
33+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
34+
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}

docs/Project.toml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,7 @@
11
[deps]
2+
ArrayLayouts = "4c555306-a7a7-4459-81d9-ec55ddd5c99a"
23
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
4+
5+
[compat]
6+
ArrayLayouts = "1"
7+
Documenter = "0.27"

docs/make.jl

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,12 @@ using ArrayLayouts
33

44
makedocs(
55
sitename = "ArrayLayouts",
6-
format = Documenter.HTML(),
76
modules = [ArrayLayouts]
87
)
98

109
# Documenter can also automatically deploy documentation to gh-pages.
1110
# See "Hosting Documentation" and deploydocs() in the Documenter manual
1211
# for more information.
13-
#=deploydocs(
14-
repo = "<repository url>"
15-
)=#
12+
deploydocs(
13+
repo = "github.com/JuliaLinearAlgebra/ArrayLayouts.jl.git",
14+
)

docs/src/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
11
# ArrayLayouts.jl
22

33
Documentation for ArrayLayouts.jl
4+
5+
```@autodocs
6+
Modules = [ArrayLayouts]
7+
```

0 commit comments

Comments
 (0)