Skip to content

Commit e086582

Browse files
authored
improve build docs locally in contribution.md (#2698)
1 parent 8bea071 commit e086582

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

CONTRIBUTING.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -64,11 +64,14 @@ and discuss it with some of the core team.
6464
You can build the documentation locally using `make`:
6565

6666
```bash
67-
# make sure your latest changes are installed
68-
pip install .
67+
# ensure pandoc is available. If not, install it: https://pandoc.org/installing.html
68+
pandoc --version
69+
# install darts locally in editable mode
70+
pip install -e .
6971
# build the docs
7072
make --directory=./docs build-all-docs
7173
```
74+
7275
After that docs will be available in `./docs/build/html` directory. You can just open `./docs/build/html/index.html` using your favourite browser.
7376

7477
### Code Formatting and Linting

0 commit comments

Comments
 (0)