Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 0e6aa3b

Browse filesBrowse files
docs: update doc building guide (#1566)
Signed-off-by: Johannes Messner <messnerjo@gmail.com>
1 parent 8651e6e commit 0e6aa3b
Copy full SHA for 0e6aa3b

1 file changed

+12-9Lines changed: 12 additions & 9 deletions

File tree

Expand file treeCollapse file tree
Open diff view settings
Filter options
Expand file treeCollapse file tree
Open diff view settings
Collapse file

‎CONTRIBUTING.md‎

Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+12-9Lines changed: 12 additions & 9 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff 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
348352
cd docs
349-
pip install -r requirements.txt
350-
export NUM_RELEASES=10
351-
bash makedoc.sh
353+
./makedoc.sh
352354
```
353355

354356
The docs website will be generated in `site`.
355357
To serve it, run:
356358

357359
```bash
358-
mkdocs serve
359-
python -m http.server
360+
cd ..
361+
poetry run mkdocs serve
360362
```
361363

362364
You 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

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.