Repository navigation
Releases
Releases · EliteRobots/Elite_Robots_CS_ROS2_Tutorials
v1.0.0 — Elite Robots ROS 2 Documentation
Highlights
This release provides four independently versioned manuals in both Chinese and English:
- Quickstart Guide — Installation, robot setup, driver startup, MoveIt 2, and Gazebo.
- Interface Reference — Launch parameters, controllers, topics, services, actions, and custom messages.
- Multi-Arm Guide — Multi-arm configuration, separate driver instances, trajectory control, and MoveIt 2 integration.
- Tutorials — Custom workcell modeling, control configuration, and MoveIt C++ application development.
Documentation and downloads
- Generate independent HTML sites and PDF manuals for each document and language.
- Use the standard Read the Docs HTML theme.
- Include downloadable multi-arm launch templates and complete MoveIt example packages.
- Collect referenced downloads in each manual’s
pdf/downloads/directory, using readable filenames and source directory structures. - Support PDF-only builds without requiring an HTML build first.
Build
Install the Python dependencies:
python -m pip install -r requirements.txt
Build all enabled manuals:
python scripts/build_docs.py --format all
Output is organized under:
build/docs/<document>/<language>/html/
build/docs/<document>/<language>/pdf/
PDF generation requires XeLaTeX, latexmk, and the fonts listed in the README. Windows PDF builds are supported.
Versioning
The ROS documentation package and all included manual editions are versioned 1.0.0 in this release. Manual versions are maintained independently of the package version and the driver/SDK versions documented within them.
Validation
- All eight document/language combinations successfully built as HTML and PDF.
- Downloaded resources were checked against their source files.
- Documentation build validation does not imply validation of every procedure on physical robots or in simulation.
See each manual’s scope and revision history for applicable software versions and validation details.