File tree Expand file tree Collapse file tree
Open diff view settings
Expand file tree Collapse file tree
Open diff view settings
Original file line number Diff line number Diff line change @@ -337,29 +337,32 @@ Good docs make developers happy, and we love happy developers! We've got a few d
337337
338338### Building documentation on your local machine
339339
340- #### Requirements
341-
342- * Python 3
343- * [ jq] ( https://stedolan.github.io/jq/download/ )
344340
345341#### Steps to build locally
346342
343+ First install the documentation dependency
344+ ```
345+ poetry install --with docs
346+ ```
347+
348+ Note: if you need to install extra (proto, database, ...) you need to specify those as well.
349+
350+ Then build the documentation:
347351``` bash
348352cd docs
349- pip install -r requirements.txt
350- export NUM_RELEASES=10
351- bash makedoc.sh
353+ ./makedoc.sh
352354```
353355
354356The docs website will be generated in ` site ` .
355357To serve it, run:
356358
357359``` bash
358- mkdocs serve
359- python -m http.server
360+ cd ..
361+ poetry run mkdocs serve
360362```
361363
362364You can now see docs website on [ http://localhost:8000 ] ( http://localhost:8000 ) on your browser.
365+ Note: You may have to change the port from 8000 to something else if you already have a server running on that port.
363366
364367## 🙏 Thank you
365368
You can’t perform that action at this time.
0 commit comments