From d3442445fdc3cbca794a8ed9eea4d39ed1a4959f Mon Sep 17 00:00:00 2001 From: Thomas Simonini Date: Thu, 1 Dec 2022 08:06:12 +0100 Subject: [PATCH] Update README.md Add that preview does not work with windows --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 5e6eb187..809bdeba 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,8 @@ doc-builder preview datasets ~/Desktop/datasets/docs/source/ ``` **`preview` command only works with existing doc files. When you add a completely new file, you need to update `_toctree.yml` & restart `preview` command (`ctrl-c` to stop it & call `doc-builder preview ...` again). + +**`preview` command does not work with Windows. ## Doc building To build the documentation of a given package, use the following command: