Skip to content

Commit adc46f5

Browse files
committed
docs: Update to a new version of documenter and skip develop
- New documenter generates `objects.inv` which allows for external references - Adding the `sources` section in the `Project.toml` ensures that the documentation is always built for the current developed version and not for the stable version fetched from the registry even if `develop` is skipped in the generation process which ensures that no head scratching issues happen during the development.
1 parent bc23a2e commit adc46f5

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

.github/workflows/docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ jobs:
3434
${{ runner.os }}-test-
3535
${{ runner.os }}-
3636
- name: Install dependencies
37-
run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
37+
run: julia --project=docs/ -e 'using Pkg; Pkg.instantiate()'
3838
- name: Build and deploy
3939
env:
4040
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

docs/Project.toml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
33
JSON = "682c06a0-de6a-54ab-a142-c8b1cf79cde6"
44
OffsetArrays = "6fe1bfb0-de20-5000-8ca7-80f57d26f881"
55

6+
[sources]
7+
OffsetArrays = { path = ".." }
8+
69
[compat]
7-
Documenter = "0.27"
10+
Documenter = "^1"
811
JSON = "0.21"

0 commit comments

Comments
 (0)