Skip to content

Commit 3e678ff

Browse files
committed
Temporarily disable examples to pass doc build
Enable it once the WannierPlots.jl is refactored as package extensions.
1 parent 07c4048 commit 3e678ff

File tree

4 files changed

+17
-16
lines changed

4 files changed

+17
-16
lines changed

Diff for: .github/workflows/CI.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@ jobs:
1515
- uses: actions/checkout@v3
1616
- uses: actions/setup-python@v4
1717
- uses: julia-actions/setup-julia@v1
18-
- uses: julia-actions/cache@v1
1918
- name: Install JuliaFormatter
2019
# This will use the latest version by default but you can set the version like so:
2120
# julia -e 'using Pkg; Pkg.add(PackageSpec(name="JuliaFormatter", version="0.13.0"))'
2221
run: |
2322
using Pkg
2423
Pkg.add("JuliaFormatter")
2524
shell: julia --color=yes {0}
25+
- uses: julia-actions/cache@v1
2626
- uses: pre-commit/[email protected]
2727
with:
2828
extra_args: "" # do not run on all files

Diff for: .github/workflows/Documenter.yml

+2
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ jobs:
1515
runs-on: ubuntu-latest
1616
steps:
1717
- uses: actions/checkout@v3
18+
- uses: julia-actions/setup-julia@v1
19+
- uses: julia-actions/cache@v1
1820
- uses: julia-actions/julia-buildpkg@v1
1921
- uses: julia-actions/julia-docdeploy@v1
2022
env:

Diff for: docs/Project.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ PlotlyJS = "f0f68f2c-4968-5e81-91da-67840de0976a"
88
WGLMakie = "276b4fcb-3e11-5398-bf8b-a0c2d153d008"
99
Wannier = "2b19380a-1f7e-4d7d-b1b8-8aa60b3321c9"
1010
WannierIO = "cb1bc77f-5443-4951-af9f-05b616a3e422"
11-
WannierPlots = "aee37571-e66d-4c92-9c5d-c978af507da2"
11+
#WannierPlots = "aee37571-e66d-4c92-9c5d-c978af507da2"
1212

1313
[compat]
1414
Documenter = "0.27"

Diff for: docs/make.jl

+13-14
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
using Documenter
2-
using WannierIO
32
using Wannier
4-
using WannierPlots
3+
# using WannierPlots
54

65
# The processing of examples take quite some time. To speed up development,
76
# set this flag to true to skip them.
8-
SKIP_EXAMPLES = false
9-
# SKIP_EXAMPLES = true
7+
# SKIP_EXAMPLES = false
8+
SKIP_EXAMPLES = true
109

1110
# The examples are auto-generated by Literate.jl.
1211
# Here you can specify the name of tutorial page shown in the left sidebar,
@@ -52,7 +51,7 @@ makedocs(;
5251
sitename="Wannier.jl",
5352
authors="Junfeng Qiao and contributors.",
5453
clean=true,
55-
modules=[WannierIO, Wannier, WannierPlots],
54+
modules=[Wannier],
5655
pages=[
5756
"Home" => "index.md",
5857
"Getting Started" => "start.md",
@@ -72,15 +71,15 @@ makedocs(;
7271
"Real space" => "api/realspace.md",
7372
"Command line" => "api/cli.md",
7473
],
75-
"WannierPlots" => [
76-
"Home" => "WannierPlots/index.md",
77-
"API" => [
78-
"Band" => "WannierPlots/api/band.md",
79-
"Real space" => "WannierPlots/api/realspace.md",
80-
"B vector" => "WannierPlots/api/bvector.md",
81-
"Fermi surface" => "WannierPlots/api/fermisurf.md",
82-
],
83-
],
74+
# "WannierPlots" => [
75+
# "Home" => "WannierPlots/index.md",
76+
# "API" => [
77+
# "Band" => "WannierPlots/api/band.md",
78+
# "Real space" => "WannierPlots/api/realspace.md",
79+
# "B vector" => "WannierPlots/api/bvector.md",
80+
# "Fermi surface" => "WannierPlots/api/fermisurf.md",
81+
# ],
82+
# ],
8483
],
8584
)
8685

0 commit comments

Comments
 (0)