Skip to content

Commit 5ec96f4

Browse files
authored
fix: add warnonly=true for readme autodocs (#235)
1 parent 9ba6f87 commit 5ec96f4

File tree

2 files changed

+17
-2
lines changed

2 files changed

+17
-2
lines changed

src/builders.jl

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -282,7 +282,8 @@ function build_readme_docs(pkgname, pkgroot, docsdir, src_prefix, href_prefix, c
282282
pages = $(pages),
283283
remotes = nothing,
284284
repo = "",
285-
doctest = false
285+
doctest = false,
286+
warnonly = true,
286287
)
287288
"""
288289

@@ -298,6 +299,8 @@ function build_readme_docs(pkgname, pkgroot, docsdir, src_prefix, href_prefix, c
298299
$(makejl_path)
299300
```
300301

302+
@info "running autodocs generation in $docsdir" makejl_str
303+
301304
succeeded = try
302305
success(pipeline(addenv(cmd, "JULIA_LOAD_PATH" => nothing); stdout=stdout, stderr=stderr))
303306
catch err
@@ -310,7 +313,7 @@ function build_readme_docs(pkgname, pkgroot, docsdir, src_prefix, href_prefix, c
310313
end
311314

312315
build_dir = joinpath(docsdir, "build")
313-
if ispath(build_dir)
316+
if ispath(build_dir) && succeeded
314317
return build_dir
315318
end
316319
return nothing

test/runtests.jl

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -304,6 +304,18 @@ end
304304
doctype = ["documenter"],
305305
using_failed = [false],
306306
),
307+
(
308+
name = "Pluto",
309+
url = "https://github.com/fonsp/Pluto.jl.git",
310+
uuid = "c3e4b0f8-55cb-11ea-2926-15256bba5781",
311+
versions = [v"0.20.6"],
312+
server_type = "github",
313+
api_url = "",
314+
installs = [true],
315+
success = [false],
316+
doctype = ["fallback_autodocs"],
317+
using_failed = [false],
318+
),
307319
]
308320

309321
basepath = @__DIR__

0 commit comments

Comments
 (0)