Skip to content

Commit 1a3eb65

Browse files
author
David Widmann
committed
Update to Documenter 1 and update CompatHelper
1 parent f16fa63 commit 1a3eb65

File tree

3 files changed

+41
-18
lines changed

3 files changed

+41
-18
lines changed

.github/workflows/CompatHelper.yml

Lines changed: 32 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,42 @@ on:
33
schedule:
44
- cron: 0 0 * * *
55
workflow_dispatch:
6+
permissions:
7+
contents: write
8+
pull-requests: write
69
jobs:
710
CompatHelper:
811
runs-on: ubuntu-latest
912
steps:
10-
- name: Pkg.add("CompatHelper")
11-
run: julia -e 'using Pkg; Pkg.add("CompatHelper")'
12-
- name: CompatHelper.main()
13+
- name: Check if Julia is already available in the PATH
14+
id: julia_in_path
15+
run: which julia
16+
continue-on-error: true
17+
- name: Install Julia, but only if it is not already available in the PATH
18+
uses: julia-actions/setup-julia@v1
19+
with:
20+
version: '1'
21+
arch: ${{ runner.arch }}
22+
if: steps.julia_in_path.outcome != 'success'
23+
- name: "Add the General registry via Git"
24+
run: |
25+
import Pkg
26+
ENV["JULIA_PKG_SERVER"] = ""
27+
Pkg.Registry.add("General")
28+
shell: julia --color=yes {0}
29+
- name: "Install CompatHelper"
30+
run: |
31+
import Pkg
32+
name = "CompatHelper"
33+
uuid = "aa819f21-2bde-4658-8897-bab36330d9b7"
34+
version = "3"
35+
Pkg.add(; name, uuid, version)
36+
shell: julia --color=yes {0}
37+
- name: "Run CompatHelper"
38+
run: |
39+
import CompatHelper
40+
CompatHelper.main(; subdirs=["", "docs"])
41+
shell: julia --color=yes {0}
1342
env:
1443
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
1544
COMPATHELPER_PRIV: ${{ secrets.DOCUMENTER_KEY }}
16-
run: julia -e 'using CompatHelper; CompatHelper.main()'

docs/Project.toml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,10 @@ GraphMakie = "1ecd5474-83a3-4783-bb4f-06765db800d2"
55
Graphs = "86223c79-3864-5bf0-83f7-82e725a168b6"
66
NetworkLayout = "46757867-2c16-5918-afeb-47bfcb05e46a"
77
Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
8+
9+
[compat]
10+
CairoMakie = "0.10"
11+
Documenter = "1"
12+
GraphMakie = "0.5"
13+
Graphs = "1.9"
14+
NetworkLayout = "0.4"

docs/make.jl

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,24 +7,12 @@ using CairoMakie
77
DocMeta.setdocmeta!(NetworkLayout, :DocTestSetup, :(using NetworkLayout); recursive=true)
88

99
makedocs(; modules=[NetworkLayout],
10-
repo="https://github.com/JuliaGraphs/NetworkLayout.jl/blob/{commit}{path}#{line}",
10+
repo=Remotes.GitHub("JuliaGraphs", "NetworkLayout.jl"),
1111
sitename="NetworkLayout.jl",
1212
format=Documenter.HTML(; prettyurls=get(ENV, "CI", "false") == "true",
1313
canonical="https://juliagraphs.org/NetworkLayout.jl", assets=String[]),
1414
pages=["Home" => "index.md",
15-
"Interface" => "interface.md"],
16-
strict=[:autodocs_block,
17-
:cross_references,
18-
:docs_block,
19-
:doctest,
20-
:eval_block,
21-
:example_block,
22-
:footnote,
23-
:linkcheck,
24-
:meta_block,
25-
#:missing_docs,
26-
:parse_error,
27-
:setup_block])
15+
"Interface" => "interface.md"])
2816

2917
# if gh_pages branch gets to big, check out
3018
# https://juliadocs.github.io/Documenter.jl/stable/man/hosting/#gh-pages-Branch

0 commit comments

Comments
 (0)