Skip to content

rudislabs/gz-docs

This branch is 37 commits behind gazebosim/docs:master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

0e243eb · Oct 22, 2024
Oct 9, 2024
Aug 3, 2024
Jul 11, 2024
Jun 30, 2022
Jul 19, 2024
Aug 6, 2024
Jul 25, 2024
Jul 25, 2024
Aug 15, 2024
Jul 19, 2024
Aug 15, 2024
Oct 15, 2024
Oct 15, 2024
Sep 30, 2024
Oct 9, 2024
Jul 11, 2024
Sep 5, 2024
Jul 11, 2024
Jul 11, 2024
Jun 30, 2022
Jul 19, 2024
Jul 11, 2024
Aug 9, 2024
Jul 19, 2024
Oct 22, 2024
Aug 12, 2022
Aug 15, 2024
Sep 30, 2024
Oct 9, 2024
May 14, 2024
Jul 11, 2024
Aug 15, 2024
Jul 11, 2024
Oct 15, 2024
Jul 19, 2024
Oct 9, 2024
Jul 11, 2024
Jul 19, 2024
Jul 19, 2024
Sep 26, 2024

Repository files navigation

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 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 http://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

Library docs

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

About

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

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 49.0%
  • C++ 29.5%
  • HTML 8.8%
  • CMake 7.1%
  • CSS 5.6%