Skip to content

Commit a14c159

Browse files
Update documentation to include venv support.
Signed-off-by: Leander Stephen D'Souza <leanderdsouza1234@gmail.com>
1 parent 82934c7 commit a14c159

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,33 @@ https://docs.nav2.org/
44
This folder holds the source and configuration files used to generate the
55
[Navigation2 documentation](https://docs.nav2.org) web site.
66

7+
8+
### Native Installation
9+
710
Dependencies for Build:
811

912
``` bash
1013
sudo apt install python3-pip
1114
pip3 install -r requirements.txt
1215
```
1316

17+
### Installation in a Virtual Environment
18+
19+
Install `pip` and `venv` if not already installed:
20+
21+
``` bash
22+
sudo apt install python3-pip python3-venv
23+
```
24+
25+
Create a virtual environment and install the dependencies:
26+
27+
``` bash
28+
python3 -m venv venv
29+
source venv/bin/activate
30+
pip3 install -r requirements.txt
31+
```
32+
33+
### Build the Docs
1434
Build the docs locally with `make html` and you'll find the built docs entry point in `_build/html/index.html`.
1535

1636
Any images, diagrams, or videos are subject to their own copyrights, trademarks, and licenses.

0 commit comments

Comments
 (0)