Skip to content

Commit 03f41cf

Browse files
committed
Add documenter
1 parent 688aef0 commit 03f41cf

File tree

4 files changed

+54
-0
lines changed

4 files changed

+54
-0
lines changed

.github/workflows/Documenter.yml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: Documenter
2+
on:
3+
push:
4+
branches: [main]
5+
tags: [v*]
6+
pull_request:
7+
8+
jobs:
9+
Documenter:
10+
permissions:
11+
contents: write
12+
name: Documentation
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v4
16+
- uses: julia-actions/julia-buildpkg@v1
17+
- uses: julia-actions/julia-docdeploy@v1
18+
env:
19+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

docs/Project.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[deps]
2+
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
3+
LibAwsCommon = "c6e421ba-b5f8-4792-a1c4-42948de3ed9d"

docs/make.jl

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
using LibAwsCommon
2+
using Documenter
3+
4+
DocMeta.setdocmeta!(LibAwsCommon, :DocTestSetup, :(using LibAwsCommon); recursive=true)
5+
6+
makedocs(;
7+
modules=[LibAwsCommon],
8+
repo="https://github.com/JuliaServices/LibAwsCommon.jl/blob/{commit}{path}#{line}",
9+
sitename="LibAwsCommon.jl",
10+
format=Documenter.HTML(;
11+
prettyurls=get(ENV, "CI", "false") == "true",
12+
canonical="https://github.com/JuliaServices/LibAwsCommon.jl",
13+
assets=String[],
14+
),
15+
pages=["Home" => "index.md"],
16+
)
17+
18+
deploydocs(; repo="github.com/JuliaServices/LibAwsCommon.jl", devbranch="main")

docs/src/index.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
```@meta
2+
CurrentModule = LibAwsCommon
3+
```
4+
5+
# LibAwsCommon
6+
7+
Documentation for [LibAwsCommon](https://github.com/JuliaServices/LibAwsCommon.jl).
8+
9+
```@index
10+
```
11+
12+
```@autodocs
13+
Modules = [LibAwsCommon]
14+
```

0 commit comments

Comments
 (0)