Skip to content

Commit 143f816

Browse files
author
vituri
committed
refactor documentation workflow: streamline dependency installation and update deployment logic
1 parent 3a52036 commit 143f816

File tree

2 files changed

+8
-11
lines changed

2 files changed

+8
-11
lines changed

.github/workflows/documentation.yml

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,10 @@ jobs:
2222
version: '1'
2323
- uses: julia-actions/cache@v2
2424
- name: Install dependencies
25-
shell: julia --color=yes --project=docs {0}
26-
run: |
27-
using Pkg
28-
Pkg.develop(PackageSpec(path=pwd()))
29-
Pkg.instantiate()
25+
run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
3026
- uses: julia-actions/julia-buildpkg@v1
31-
- name: Build and deploy docs
32-
run: julia --color=yes --project=docs docs/make.jl
27+
- name: Build and deploy docs
3328
env:
3429
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
3530
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
31+
run: julia --project=docs/ docs/make.jl

docs/make.jl

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ makedocs(;
66
sitename="MetricSpaces.jl",
77
authors="G. Vituri <56522687+vituri@users.noreply.github.com> and contributors",
88
format=Documenter.HTML(
9+
;
910
prettyurls=get(ENV, "CI", "false") == "true",
1011
assets=String[],
1112
),
@@ -19,14 +20,14 @@ makedocs(;
1920
"Sampling Methods" => "sampling.md",
2021
"Neighborhood Analysis" => "neighborhoods.md",
2122
"Datasets" => "datasets.md",
22-
"API Reference" => "api.md"
23+
"API Reference" => "api.md"
2324
],
24-
checkdocs=:exports
25+
checkdocs=:exports,
26+
doctest=false
2527
)
2628

2729
# Deploy documentation if running in CI
2830
deploydocs(;
29-
repo="github.com/juliatda/MetricSpaces.jl.git",
30-
devbranch="main"
31+
repo="github.com/JuliaTDA/MetricSpaces.jl.git"
3132
)
3233

0 commit comments

Comments
 (0)