Skip to content

Commit 29bceb8

Browse files
author
Saurabh Kumar
committed
chore: add how to run docs locally
1 parent cb53e1e commit 29bceb8

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,14 @@ or with [tox](https://pypi.org/project/tox/) installed:
1616

1717
$ tox
1818

19+
20+
Documentation is published with [mkdocs]():
21+
22+
```shell
23+
$ pip install -r requirements.txt
24+
$ pip install -e .
25+
$ mkdocs serve
26+
```
27+
28+
Open http://127.0.0.1:8000/ to view the documentation locally.
29+

0 commit comments

Comments
 (0)