diff --git a/antora.yml b/antora.yml new file mode 100644 index 0000000..c62fa1a --- /dev/null +++ b/antora.yml @@ -0,0 +1,6 @@ +name: sofware_documentation +title: Software documentation +version: latest +start_page: ROOT:index.adoc +nav: + - modules/ROOT/nav.adoc diff --git a/modules/ROOT/_attributes.adoc b/modules/ROOT/_attributes.adoc new file mode 100644 index 0000000..9bd30dc --- /dev/null +++ b/modules/ROOT/_attributes.adoc @@ -0,0 +1,5 @@ +:attachmentsdir: {moduledir}/assets/attachments +:exampledir: {moduledir}/assets/examples +:imagesdir: {moduledir}/assets/images +:partialsdir: {moduledir}/assets/_partials + diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc new file mode 100644 index 0000000..15a951a --- /dev/null +++ b/modules/ROOT/nav.adoc @@ -0,0 +1,5 @@ +* xref:index.adoc[Welcome] +* xref:data_format.adoc[Input data format] +* xref:model.adoc[Human model] +* xref:pi_spec.adoc[Performance indicator] +* xref:template.adoc[Protocol template] \ No newline at end of file diff --git a/modules/ROOT/pages/_attributes.adoc b/modules/ROOT/pages/_attributes.adoc new file mode 100644 index 0000000..fb98244 --- /dev/null +++ b/modules/ROOT/pages/_attributes.adoc @@ -0,0 +1,2 @@ +:moduledir: .. +include::{moduledir}/_attributes.adoc[] diff --git a/data_format.adoc b/modules/ROOT/pages/data_format.adoc similarity index 100% rename from data_format.adoc rename to modules/ROOT/pages/data_format.adoc diff --git a/file/protocol_template.xlsx b/modules/ROOT/pages/file/protocol_template.xlsx similarity index 100% rename from file/protocol_template.xlsx rename to modules/ROOT/pages/file/protocol_template.xlsx diff --git a/img/df_angle_convention.png b/modules/ROOT/pages/img/df_angle_convention.png similarity index 100% rename from img/df_angle_convention.png rename to modules/ROOT/pages/img/df_angle_convention.png diff --git a/img/df_joint_center_label.png b/modules/ROOT/pages/img/df_joint_center_label.png similarity index 100% rename from img/df_joint_center_label.png rename to modules/ROOT/pages/img/df_joint_center_label.png diff --git a/img/df_processing_chain.png b/modules/ROOT/pages/img/df_processing_chain.png similarity index 100% rename from img/df_processing_chain.png rename to modules/ROOT/pages/img/df_processing_chain.png diff --git a/img/df_segment_label.png b/modules/ROOT/pages/img/df_segment_label.png similarity index 100% rename from img/df_segment_label.png rename to modules/ROOT/pages/img/df_segment_label.png diff --git a/img/pi_manager_interaction.png b/modules/ROOT/pages/img/pi_manager_interaction.png similarity index 100% rename from img/pi_manager_interaction.png rename to modules/ROOT/pages/img/pi_manager_interaction.png diff --git a/img/pi_manager_loop.png b/modules/ROOT/pages/img/pi_manager_loop.png similarity index 100% rename from img/pi_manager_loop.png rename to modules/ROOT/pages/img/pi_manager_loop.png diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc new file mode 100644 index 0000000..7e8ea5e --- /dev/null +++ b/modules/ROOT/pages/index.adoc @@ -0,0 +1,39 @@ += Eurobench Software documentation +:source-highlighter: pygments +:pygments-style: emacs +:icons: font +:linkattrs: + + +This document gathers documentation on software aspects related to the http://eurobench2020.eu/[Eurobench] project: + +* <> +* <> +* <> +* <> + +== Modification Instructions + +All the documentation is subject to evolution according to http://eurobench2020.eu/[Eurobench] needs. +If you identify errors, or want to provide additional material, please use traditional Github tools: + +* Create an issue through the https://help.github.com/en/github/managing-your-work-on-github/creating-an-issue[Git Hub Interface] +** please indicate the specific section you are referring to. +* Create an issue from the code file through the https://help.github.com/en/github/managing-your-work-on-github/opening-an-issue-from-code[Git Hub interface] +* Send an email to us (anthony.remazeilles@tecnalia.com Leader of WP6: Software Development). + +== Additional Tools + +To generate locally the documentation (under Linux), type from the repository root the command `make`. +It requires `make` and `asciidoctor` installed locally. + +--- + +image::http://eurobench2020.eu/wp-content/uploads/2018/06/cropped-logoweb.png["eurobench logo", width=200, role=left] +Supported by Eurobench - the European robotic platform for bipedal locomotion benchmarking. +More information: http://eurobench2020.eu/[eurobench2020.eu]). + + +image::http://eurobench2020.eu/wp-content/uploads/2018/02/euflag.png["euflag",float=left,width=100] +This project has received funding from the European Union’s Horizon 2020 +research and innovation programme under grant agreement no. No 779963. diff --git a/model.adoc b/modules/ROOT/pages/model.adoc similarity index 100% rename from model.adoc rename to modules/ROOT/pages/model.adoc diff --git a/pi_spec.adoc b/modules/ROOT/pages/pi_spec.adoc similarity index 100% rename from pi_spec.adoc rename to modules/ROOT/pages/pi_spec.adoc diff --git a/template.adoc b/modules/ROOT/pages/template.adoc similarity index 100% rename from template.adoc rename to modules/ROOT/pages/template.adoc