File tree Expand file tree Collapse file tree 2 files changed +21
-0
lines changed Expand file tree Collapse file tree 2 files changed +21
-0
lines changed Original file line number Diff line number Diff line change @@ -140,7 +140,26 @@ function make(
140
140
canonical_domain:: Union{AbstractString,Nothing} = nothing ,
141
141
sitemap:: Bool = false ,
142
142
sitemap_filename:: AbstractString = " sitemap.xml" ,
143
+ # This keyword is for internal test use only:
144
+ _override_windows_isinteractive_check:: Bool = false ,
143
145
)
146
+ if Sys. iswindows () && ! isinteractive ()
147
+ if _override_windows_isinteractive_check || isinteractive ()
148
+ @warn """
149
+ Running a MultiDocumenter build interactively in Windows.
150
+ This should only be used for development and testing, as it will lead to partial
151
+ and broken builds. See https://github.com/JuliaComputing/MultiDocumenter.jl/issues/70
152
+ """
153
+ else
154
+ msg = """
155
+ MultiDocumenter deployments are disabled on Windows due to difficulties
156
+ with handling symlinks in documentation sources.
157
+ You _can_ test this build locally by running it interactively (i.e. in the REPL).
158
+ See also: https://github.com/JuliaComputing/MultiDocumenter.jl/issues/70
159
+ """
160
+ error (msg)
161
+ end
162
+ end
144
163
if isnothing (canonical_domain)
145
164
(sitemap === true ) &&
146
165
throw (ArgumentError (" When sitemap=true, canonical_domain must also be set" ))
Original file line number Diff line number Diff line change @@ -100,6 +100,8 @@ MultiDocumenter.make(
100
100
canonical_domain = " https://example.org/" ,
101
101
sitemap = true ,
102
102
sitemap_filename = " sitemap-mydocs.xml" ,
103
+ # The following keyword is not standard:
104
+ _override_windows_isinteractive_check = Sys. iswindows (),
103
105
)
104
106
105
107
@testset " MultiDocumenter.jl" begin
You can’t perform that action at this time.
0 commit comments