chenyenru / docs

High-level Gazebo documentation that gets published to https://gazebosim.org/docs/

Gazebo Documentation

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.

Updating gazebosim.org

Main docs

The documentation in this repository is updated whenever the gazebosim-web-backend, is deployed. The gazebosim-web-backend webserver maintains a clone of this repository, and serves the markdown pages to https://gazebosim.org/docs.

Library docs

Instructions on how to update all of the library docs is contained in the tools/build_docs.sh script.