https://docs.nav2.org/

This folder holds the source and configuration files used to generate the Navigation2 documentation web site.

Dependencies for Build:

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

Install pip and venv if not already installed:

sudo apt install python3-pip python3-venv

Create a virtual environment and install the dependencies:

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

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

To automate the build process, you can use a sphinx-autobuild package.
Run this command from the virtual environment to build the documentation and start a server:

sphinx-autobuild . ./_build/html

For more options for the command, see the documentation linked above.

Now you can access the page using the local address: http://127.0.0.1:8000.
After saving any changes, the documentation will be automatically rebuilt and displayed.

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

Want a local PDF version? Follow the instructions here.