https://github.com/robotology/yarp-documentation
Documentation for YARP
https://github.com/robotology/yarp-documentation
documentation robotics yarp
Last synced: 3 months ago
JSON representation
Documentation for YARP
- Host: GitHub
- URL: https://github.com/robotology/yarp-documentation
- Owner: robotology
- Created: 2020-08-10T10:30:25.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2025-06-19T02:49:19.000Z (about 1 year ago)
- Last Synced: 2025-06-19T03:34:16.722Z (about 1 year ago)
- Topics: documentation, robotics, yarp
- Homepage: http://www.yarp.it
- Size: 5.3 GB
- Stars: 1
- Watchers: 9
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# yarp-documentation
Documentation for YARP
This repo generates the documentation that is displayed on the web page https://yarp.it
It works in the following way:
- This [github action](https://github.com/robotology/yarp-documentation/blob/master/.github/workflows/gh-pages.yml) is periodically executed from the `master` branch.
- The action checks for all yarp releases (tags) published on [yarp](https://github.com/robotology/yarp). If a new one is found, then the action runs doxygen on it to generate the new documentation. Otherwise, it skips it.
The github action also checks for auxiliary repos found in the [robotology](https://github.com/robotology) organization, which have the prefix `yarp-devices-` or `yarp-device-`.
These repos are cloned into the folder `yarp/opt-modules` which is scanned by Doxygen to generate the documentation for these plugins.
- The output of the Doxygen is committed to the branch `yarp_it_pages`.
- The branch `yarp-it-pages` is periodically published onto https://yarp.it (not from this github action)