This document gathers documentation on software aspects related to the Eurobench project.
All material is automatically deployed to this github Website.
The principle documentation pages are the following:
All the documentation is subject to evolution according to Eurobench needs. If you identify errors, or want to provide additional material, please use traditional GitHub tools:
-
Create an issue through the Git Hub Interface
-
please indicate the specific section you are referring to.
-
-
Create an issue from the code file through the Git Hub interface
-
Send an email to us ([email protected] Leader of WP6: Software Development).
The repository is using Antora to generate a static website from this content. Antora requires 3 components:
-
Components that contain the information to deploy. That is this repository. The structure of this repo is thus guided by Antora’s requirements.
-
A UI themes which configures the graphical aspect of the website. We use a fork of the default UI, located in the Eurobench organization’s github.
-
A playbook that contains the configuration to be used by Antora to generate the static pages. The one we used in stored in the Eurobench organization’s github.
General information on the Antora concepts can be found here.
All the deployment is then handled through the GitHub actions of this website.
To generate locally the documentation (under Linux), type from the repository root the command make.
It requires make and asciidoctor installed locally.
|
Warning
|
Look for html pages in folder modules/ROOT/pages.
The link towards other pages may not be working locally.
|
|
Supported by Eurobench - the European robotic platform for bipedal locomotion benchmarking. More information: eurobench2020.eu. |
|
This project has received funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement no. No 779963. |
