Skip to content

Add venv support #697

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SteveMacenski merged 2 commits into from
May 23, 2025
Merged

Add venv support #697

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
82934c7
Update .gitignore to include Python virtual environment directories.
leander-dsouza May 21, 2025
a14c159
Update documentation to include venv support.
leander-dsouza May 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ lib/
bin/
pyvenv.cfg
.DS_Store
venv/
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,33 @@ https://docs.nav2.org/
This folder holds the source and configuration files used to generate the
[Navigation2 documentation](https://docs.nav2.org) web site.


### Native Installation

Dependencies for Build:

``` bash
sudo apt install python3-pip
pip3 install -r requirements.txt
```

### Installation in a Virtual Environment

Install `pip` and `venv` if not already installed:

``` bash
sudo apt install python3-pip python3-venv
```

Create a virtual environment and install the dependencies:

``` bash
python3 -m venv venv
source venv/bin/activate
pip3 install -r requirements.txt
```

### Build the Docs
Build the docs locally with `make html` and you'll find the built docs entry point in `_build/html/index.html`.

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