Initial setup for Antora

Signed-off-by: Philip Windecker <philip.windecker@avenyr.de>

Author: philipwindecker

.antora/antora.yml

@@ -0,0 +1,9 @@
+# Component name (without spaces!). All content repositories with the same component name are merged in Antora.
+name: asamosi
+version:
+  # Update version number accordingly. This is the version for the main branch
+  main: 'current'
+  v(*): V$1
+  V(*): V$1
+  # Update version number accordingly. This is the version for any other activated branch (branch must be added in the generator site.yml!). Schema = 0.0.x-<branch-name> (only works for branches starting with "feature/")
+  (*): '3.6.0-$1'

.antora/modules/interface/images

@@ -0,0 +1 @@
+../../../doc/images

.antora/modules/interface/nav.adoc

@@ -0,0 +1,22 @@
+[preface]
+* xref:00_preface/00_foreword.adoc[]
+[preface]
+* xref:00_preface/01_introduction.adoc[]
+* xref:01_scope/01_scope.adoc[]
+* xref:02_normative_references/01_normative_references.adoc[]
+* xref:03_terms_and_definitions/01_terms_and_definitions.adoc[]
+* xref:04_abbreviations/01_abbreviations.adoc[]
+* xref:05_backward_compatibility/01_backward_compatibility.adoc[]
+
+[appendix]
+* xref:xx_annexes/REPLACE_ME.adoc[]
+[bibliography]
+* xref:bibliography.adoc[]
+
+:sectnums!:
+* xref:list_of_figures.adoc[]
+
+:sectnums!:
+* xref:list_of_tables.adoc[]
+
+// TODO Replace with generator

.antora/modules/interface/pages

@@ -0,0 +1 @@
+../../../doc

doc/_config.adoc

@@ -0,0 +1,57 @@
+
+// This file contains AsciiDoc attributes that shall be used in every AsciiDoc file.
+// NOTE: Its content is only applied for Asciidoctor!
+// If the same attribute is defined in the antora.yml (without @), the antora.yml definition takes precedence for Antora.
+
+ifndef::root-path[:root-path: ./]
+
+:partials-path: {root-path}../_additional_content
+:asciidoc-resources: ../asciidoc-resources
+:appendix-caption: Annex
+
+// ifndef::use-antora-rules,include-only-once[]
+ifndef::include-only-once[]
+:GLO_VAR_STA_ASAM_OpenCRG: ASAM OpenCRG
+:glo_var_sta_asam_opencrg: {GLO_VAR_STA_ASAM_OpenCRG}
+:GLO_VAR_STA_ASAM_OpenDRIVE: ASAM OpenDRIVE
+:GLO_VAR_STA_ASAM_OpenLABEL: ASAM OpenLABEL
+:GLO_VAR_STA_ASAM_OpenODD: ASAM OpenODD
+:GLO_VAR_STA_ASAM_OSI: ASAM OSI®
+:GLO_VAR_STA_ASAM_OpenSCENARIO: ASAM OpenSCENARIO
+:GLO_VAR_STA_ASAM_OpenXOntology: ASAM OpenXOntology
+:GLO_VAR_STA_BSI_PAS_1883: BSI PAS 1883
+:revnumber: --localbuild--
+:revdate: {docdate}
+:bibtex-file: ./content/general_docs/bibliography.bib
+// Replace PLACEHOLDER with the name of your standard, e.g. OpenDRIVE
+:THIS_STANDARD: {GLO_VAR_STA_ASAM_OSI}
+:asam-terminology: https://code.asam.net/common/asam-terminology/-/raw/main/terms_and_definitions_opendrive.adoc
+:imagesdir: {root-path}/images
+:include-only-once: true
+:topicdir: topics
+:reusedir: reuse
+:toclevels: 3
+:xrefstyle: full
+:images_open_simulation_interface: ./open-simulation-interface/doc/images
+// :images_osi-sensor-model-packaging: ./osi-sensor-model-packaging/doc/images
+:doc_open_simulation_interface: ../../open-simulation-interface/doc/
+:doc_osi-sensor-model-packaging: ../../osi-sensor-model-packaging/doc/
+// Since a document spanning multiple repos is rendered here, the pathing regarding images is a bit involved.
+// We create a variable for every repo that is included. It point to the repo in question.
+// If the subrepo is rendered seperatly, then the variable is set to just "./images" with ifdef.
+// Please note that this variable has to used in all image includes. Includes here have to use "image::./images..."
+// :images_osi_sensor_model_packaging: ./osi-sensor-model-packaging/doc/images  // example
+:imagesoutdir: ./images/generated_images
+
+endif::[]
+
+ifndef::use-antora-rules[]
+include::{asciidoc-resources}/preamble.adoc[]
+endif::[]
+
+ifdef::env-gitlab[]
+:relfilesuffix: .adoc
+endif::[]
+
+
+:asciidoc-resources: ../0_resources

doc/architecture/architecture_overview.adoc

@@ -1,5 +1,10 @@
 = Overview of OSI architecture
 
+ifndef::include-only-once[]
+:root-path: ../
+include::{root-path}_config.adoc[]
+endif::[]
+
 OSI contains an object-based environment description that uses the message format of the https://github.com/protocolbuffers/protobuf/wiki[Protocol Buffer] library.
 Google developed and maintains the Protocol Buffer library.
 OSI defines top-level messages that are used to exchange data between separate models.

doc/architecture/data_layer.adoc

@@ -1,5 +1,10 @@
 = Data layer
 
+ifndef::include-only-once[]
+:root-path: ../
+include::{root-path}_config.adoc[]
+endif::[]
+
 The OSI data layer is defined in the message specifications using the ProtoBuf IDL cite:[protobuf].
 This defines the data that can be transmitted using OSI, including the structure and the semantics of the data.
 

doc/architecture/environmental_effect_model.adoc

@@ -1,5 +1,10 @@
 = Environmental effect model
 
+ifndef::include-only-once[]
+:root-path: ../
+include::{root-path}_config.adoc[]
+endif::[]
+
 Environmental effect models consume `SensorView` messages and produce `SensorView` messages.
 Environmental effect models may, for example, alter `SensorView` messages to include effects and phenomena caused by:
 

doc/architecture/feature_data.adoc

@@ -1,5 +1,10 @@
 = Feature data
 
+ifndef::include-only-once[]
+:root-path: ../
+include::{root-path}_config.adoc[]
+endif::[]
+
 `FeatureData` messages contain detected features in the reference frame of a sensor.
 `FeatureData` messages are generated from `GroundTruth` messages.
 They serve, for example, as an input to sensor models simulating object detection or feature fusion models.

doc/architecture/formatting_scripts.adoc

@@ -1,5 +1,10 @@
 = Trace-file formatting scripts
 
+ifndef::include-only-once[]
+:root-path: ../
+include::{root-path}_config.adoc[]
+endif::[]
+
 The OSI repository contains Python scripts for converting trace files from one format to another.
 The formatting scripts are stored in `open-simulation-interface/format/`