Skip to content

Commit

Permalink
Update README.md (#332)
Browse files Browse the repository at this point in the history
Add that preview does not work with windows
  • Loading branch information
simoninithomas authored Dec 15, 2022
1 parent 207db9a commit f4adaec
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit f4adaec

Please sign in to comment.