Skip to content

fix: add warnonly=true for readme autodocs #235

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vdayanand merged 1 commit into from
Apr 23, 2025
Merged

fix: add warnonly=true for readme autodocs #235

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions src/builders.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,8 @@ function build_readme_docs(pkgname, pkgroot, docsdir, src_prefix, href_prefix, c
pages = $(pages),
remotes = nothing,
repo = "",
doctest = false
doctest = false,
warnonly = true,
)
"""

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

@info "running autodocs generation in $docsdir" makejl_str

succeeded = try
success(pipeline(addenv(cmd, "JULIA_LOAD_PATH" => nothing); stdout=stdout, stderr=stderr))
catch err
Expand All @@ -310,7 +313,7 @@ function build_readme_docs(pkgname, pkgroot, docsdir, src_prefix, href_prefix, c
end

build_dir = joinpath(docsdir, "build")
if ispath(build_dir)
if ispath(build_dir) && succeeded
return build_dir
end
return nothing
Expand Down
12 changes: 12 additions & 0 deletions test/runtests.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -304,6 +304,18 @@ end
doctype = ["documenter"],
using_failed = [false],
),
(
name = "Pluto",
url = "https://github.com/fonsp/Pluto.jl.git",
uuid = "c3e4b0f8-55cb-11ea-2926-15256bba5781",
versions = [v"0.20.6"],
server_type = "github",
api_url = "",
installs = [true],
success = [false],
doctype = ["fallback_autodocs"],
using_failed = [false],
),
]

basepath = @__DIR__
Expand Down