Skip to content

Commit 2b53b59

Browse files
committed
add comment, readme notes
1 parent 4c99bca commit 2b53b59

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,3 +84,7 @@ Check [`.github/workflows/deploy.yml`](.github/workflows/deploy.yml) and [`docs/
8484
The result of that script is available at [https://juliacomputing.github.io/MultiDocumenter.jl/](https://juliacomputing.github.io/MultiDocumenter.jl/).
8585

8686
You can of course also just push the output artefact directly to S3 or some other hosting service.
87+
88+
> **Warning**
89+
> MultiDocumenter sites can not be deployed on Windows right now.
90+
> See [#70](https://github.com/JuliaComputing/MultiDocumenter.jl/issues/70).

test/runtests.jl

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,10 @@ docs = [
8585
),
8686
]
8787

88-
if Sys.iswindows()
88+
# We do not support deploying docs on Windows at the moment, and MultiDocumenter
89+
# should throw an error if it's being run on Windows (in a non-interactive session).
90+
# See also: https://github.com/JuliaComputing/MultiDocumenter.jl/issues/70
91+
if Sys.iswindows() && !isinteractive()
8992
@test_throws ErrorException MultiDocumenter.make(
9093
outpath,
9194
docs;

0 commit comments

Comments
 (0)