This repository contains the sources for the ROS 2 real-time working group documentation that is hosted at https://real-time-working-group.readthedocs.io. The sources from this repository are automatically fetched and built on every commit.
Contributions to this site are most welcome. Please be sure to read the below sections carefully before contributing.
The site is built using Sphinx
This repository is setup with one branch per ROS 2 distribution to handle differences between the distributions.
If a change is common to all ROS 2 distributions, it should be made to the rolling branch (and then will be back-ported as appropriate).
If a change is specific to a particular ROS 2 distribution, it should be made to the respective branch.
The source files for the site are all located under the source directory.
The root directory contains configuration and files required to locally build the site for testing.
To build the site for just this branch, type the following commands at the top-level of the repository.
cd ~
git clone https://github.com/ros-realtime/rtwg_documentation
cd rtwg_documentation
docker build -t rtwg_documentation .
docker run -v "$(pwd)":/docs -u $(id -u):$(id -g) -it rtwg_documentationBuild results are located at ~/rtwg_documentation/build/index.html.
This is the recommended way to test out local changes.
To run the site locally, type the following commands at the top-level of the repository.
cd build
python3 -m http.server --bind <your machine IP>It will be accessible remotely at http://:8000/index.html
To contribute to the project please refer to the How to Contribute.