This repository contains documentation about Gazebo that does not pertain to a specific Gazebo library. An example would be installation instructions for an Gazebo release. The documentation contained in this repository can be view at https://gazebosim.org/docs.
Each Gazebo library maintains
documentation and tutorials that are scoped to the features and
capabilities of the library itself. The documentation for a library can be
found under the API Reference
section of https://gazebosim.org/docs.
The documentation in this repository is built using Sphinx. To build, you need to install the following:
- python virtualenv
Create the virtual env and activate it:
python3 -m venv .venv
source .venv/bin/activate
Then install the necessary dependencies:
pip install -r requirements.txt
python3 build_multiversion.py
This will build all the documentation for all versions of Gazebo.
You can preview the result locally by running an HTTP server on
the output directory .build
. For example:
python3 -m http.server 8000 -d .build
This will serve the website on https://localhost:8000
For quicker iteration, you can build the documentation for a subset
of Gazebo versions. To build garden
and harmonic
:
python3 build_multiversion.py --release garden harmonic
Instructions on how to update all of the library docs is contained in the tools/build_docs.sh script.