initial antora compliant structure

aremazeilles · Oct 13, 2020 · e7ba3cb · e7ba3cb
1 parent be55bf7
commit e7ba3cb
Show file tree

Hide file tree

Showing 16 changed files with 57 additions and 0 deletions.
diff --git a/antora.yml 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
@@ -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
@@ -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]
diff --git a/modules/ROOT/pages/_attributes.adoc b/modules/ROOT/pages/_attributes.adoc
@@ -0,0 +1,2 @@
+:moduledir: ..
+include::{moduledir}/_attributes.adoc[]
diff --git a/data_format.adoc → modules/ROOT/pages/data_format.adoc b/data_format.adoc → modules/ROOT/pages/data_format.adoc
diff --git a/file/protocol_template.xlsx → ...es/ROOT/pages/file/protocol_template.xlsx b/file/protocol_template.xlsx → ...es/ROOT/pages/file/protocol_template.xlsx
diff --git a/img/df_angle_convention.png → ...es/ROOT/pages/img/df_angle_convention.png b/img/df_angle_convention.png → ...es/ROOT/pages/img/df_angle_convention.png
diff --git a/img/df_joint_center_label.png → .../ROOT/pages/img/df_joint_center_label.png b/img/df_joint_center_label.png → .../ROOT/pages/img/df_joint_center_label.png
diff --git a/img/df_processing_chain.png → ...es/ROOT/pages/img/df_processing_chain.png b/img/df_processing_chain.png → ...es/ROOT/pages/img/df_processing_chain.png
diff --git a/img/df_segment_label.png → modules/ROOT/pages/img/df_segment_label.png b/img/df_segment_label.png → modules/ROOT/pages/img/df_segment_label.png
diff --git a/img/pi_manager_interaction.png → ...ROOT/pages/img/pi_manager_interaction.png b/img/pi_manager_interaction.png → ...ROOT/pages/img/pi_manager_interaction.png
diff --git a/img/pi_manager_loop.png → modules/ROOT/pages/img/pi_manager_loop.png b/img/pi_manager_loop.png → modules/ROOT/pages/img/pi_manager_loop.png
diff --git a/modules/ROOT/pages/index.adoc 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:
+
+* <<model.adoc#Human model, Human model>>
+* <<data_format.adoc#Eurobench Data Format, Eurobench Data Format>>
+* <<template.adoc#Eurobench template, Eurobench protocol templates>>
+* <<pi_spec.adoc#Performance Indicator Specification, Performance Indicator Algorithm specification>>
+
+== 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 ([email protected] 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 → modules/ROOT/pages/model.adoc b/model.adoc → modules/ROOT/pages/model.adoc
diff --git a/pi_spec.adoc → modules/ROOT/pages/pi_spec.adoc b/pi_spec.adoc → modules/ROOT/pages/pi_spec.adoc
diff --git a/template.adoc → modules/ROOT/pages/template.adoc b/template.adoc → modules/ROOT/pages/template.adoc
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		:moduledir: ..
		include::{moduledir}/_attributes.adoc[]