Skip to content

Commit 93be9e0

Browse files
philipwindeckerphilipwindecker
committed
Initial setup for Antora
Signed-off-by: Philip Windecker <[email protected]>
1 parent 700133d commit 93be9e0

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+307
-17
lines changed

‎.antora/antora.yml

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Component name (without spaces!). All content repositories with the same component name are merged in Antora.
2+
name: asamosi
3+
version:
4+
# Update version number accordingly. This is the version for the main branch
5+
main: 'current'
6+
v(*): V$1
7+
V(*): V$1
8+
# 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/")
9+
(*): '3.6.0-$1'

‎.antora/modules/interface/images

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../doc/images

‎.antora/modules/interface/nav.adoc

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
[preface]
2+
* xref:00_preface/00_foreword.adoc[]
3+
[preface]
4+
* xref:00_preface/01_introduction.adoc[]
5+
* xref:01_scope/01_scope.adoc[]
6+
* xref:02_normative_references/01_normative_references.adoc[]
7+
* xref:03_terms_and_definitions/01_terms_and_definitions.adoc[]
8+
* xref:04_abbreviations/01_abbreviations.adoc[]
9+
* xref:05_backward_compatibility/01_backward_compatibility.adoc[]
10+
11+
[appendix]
12+
* xref:xx_annexes/REPLACE_ME.adoc[]
13+
[bibliography]
14+
* xref:bibliography.adoc[]
15+
16+
:sectnums!:
17+
* xref:list_of_figures.adoc[]
18+
19+
:sectnums!:
20+
* xref:list_of_tables.adoc[]
21+
22+
// TODO Replace with generator

‎.antora/modules/interface/pages

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../doc

‎doc/_config.adoc

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
2+
// This file contains AsciiDoc attributes that shall be used in every AsciiDoc file.
3+
// NOTE: Its content is only applied for Asciidoctor!
4+
// If the same attribute is defined in the antora.yml (without @), the antora.yml definition takes precedence for Antora.
5+
6+
ifndef::root-path[:root-path: ./]
7+
8+
:partials-path: {root-path}../_additional_content
9+
:asciidoc-resources: ../asciidoc-resources
10+
:appendix-caption: Annex
11+
12+
// ifndef::use-antora-rules,include-only-once[]
13+
ifndef::include-only-once[]
14+
:GLO_VAR_STA_ASAM_OpenCRG: ASAM OpenCRG
15+
:glo_var_sta_asam_opencrg: {GLO_VAR_STA_ASAM_OpenCRG}
16+
:GLO_VAR_STA_ASAM_OpenDRIVE: ASAM OpenDRIVE
17+
:GLO_VAR_STA_ASAM_OpenLABEL: ASAM OpenLABEL
18+
:GLO_VAR_STA_ASAM_OpenODD: ASAM OpenODD
19+
:GLO_VAR_STA_ASAM_OSI: ASAM OSI®
20+
:GLO_VAR_STA_ASAM_OpenSCENARIO: ASAM OpenSCENARIO
21+
:GLO_VAR_STA_ASAM_OpenXOntology: ASAM OpenXOntology
22+
:GLO_VAR_STA_BSI_PAS_1883: BSI PAS 1883
23+
:revnumber: --localbuild--
24+
:revdate: {docdate}
25+
:bibtex-file: ./content/general_docs/bibliography.bib
26+
// Replace PLACEHOLDER with the name of your standard, e.g. OpenDRIVE
27+
:THIS_STANDARD: {GLO_VAR_STA_ASAM_OSI}
28+
:asam-terminology: https://code.asam.net/common/asam-terminology/-/raw/main/terms_and_definitions_opendrive.adoc
29+
:imagesdir: {root-path}/images
30+
:include-only-once: true
31+
:topicdir: topics
32+
:reusedir: reuse
33+
:toclevels: 3
34+
:xrefstyle: full
35+
:images_open_simulation_interface: ./open-simulation-interface/doc/images
36+
// :images_osi-sensor-model-packaging: ./osi-sensor-model-packaging/doc/images
37+
:doc_open_simulation_interface: ../../open-simulation-interface/doc/
38+
:doc_osi-sensor-model-packaging: ../../osi-sensor-model-packaging/doc/
39+
// Since a document spanning multiple repos is rendered here, the pathing regarding images is a bit involved.
40+
// We create a variable for every repo that is included. It point to the repo in question.
41+
// If the subrepo is rendered seperatly, then the variable is set to just "./images" with ifdef.
42+
// Please note that this variable has to used in all image includes. Includes here have to use "image::./images..."
43+
// :images_osi_sensor_model_packaging: ./osi-sensor-model-packaging/doc/images // example
44+
:imagesoutdir: ./images/generated_images
45+
46+
endif::[]
47+
48+
ifndef::use-antora-rules[]
49+
include::{asciidoc-resources}/preamble.adoc[]
50+
endif::[]
51+
52+
ifdef::env-gitlab[]
53+
:relfilesuffix: .adoc
54+
endif::[]
55+
56+
57+
:asciidoc-resources: ../0_resources

‎doc/architecture/architecture_overview.adoc

+5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
= Overview of OSI architecture
22

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

‎doc/architecture/data_layer.adoc

+5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
= Data layer
22

3+
ifndef::include-only-once[]
4+
:root-path: ../
5+
include::{root-path}_config.adoc[]
6+
endif::[]
7+
38
The OSI data layer is defined in the message specifications using the ProtoBuf IDL cite:[protobuf].
49
This defines the data that can be transmitted using OSI, including the structure and the semantics of the data.
510

‎doc/architecture/environmental_effect_model.adoc

+5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
= Environmental effect model
22

3+
ifndef::include-only-once[]
4+
:root-path: ../
5+
include::{root-path}_config.adoc[]
6+
endif::[]
7+
38
Environmental effect models consume `SensorView` messages and produce `SensorView` messages.
49
Environmental effect models may, for example, alter `SensorView` messages to include effects and phenomena caused by:
510

‎doc/architecture/feature_data.adoc

+5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
= Feature data
22

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

‎doc/architecture/formatting_scripts.adoc

+5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
= Trace-file formatting scripts
22

3+
ifndef::include-only-once[]
4+
:root-path: ../
5+
include::{root-path}_config.adoc[]
6+
endif::[]
7+
38
The OSI repository contains Python scripts for converting trace files from one format to another.
49
The formatting scripts are stored in `open-simulation-interface/format/`
510

‎doc/architecture/ground_truth.adoc

+5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
= Ground truth
22

3+
ifndef::include-only-once[]
4+
:root-path: ../
5+
include::{root-path}_config.adoc[]
6+
endif::[]
7+
38
`GroundTruth` messages describe the simulated environment containing all simulated objects in the global coordinate system at consecutive time instances.
49
They are based on data available to the simulation environment.
510
`GroundTruth` messages are typically contained in `Sensorview` messages.

‎doc/architecture/logical_model.adoc

+5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
= Logical model
22

3+
ifndef::include-only-once[]
4+
:root-path: ../
5+
include::{root-path}_config.adoc[]
6+
endif::[]
7+
38
Logical models consume `SensorData` messages and produce `SensorData` messages.
49

510
An example of a logical model is a sensor-fusion model, which combines the output of multiple sensor models to produce data with less uncertainty.

‎doc/architecture/packaging_layer.adoc

+5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
= Packaging layer
22

3+
ifndef::include-only-once[]
4+
:root-path: ../
5+
include::{root-path}_config.adoc[]
6+
endif::[]
7+
38
The OSI packaging layer specifies how components that use the OSI data layer, for example, sensor models, are packaged for exchange.
49

510
This specifies model types and their mandatory and optional OSI inputs, OSI outputs, and parameter interfaces.

‎doc/architecture/proto-files.adoc

+5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
= Protobuffer files
22

3+
ifndef::include-only-once[]
4+
:root-path: ../
5+
include::{root-path}_config.adoc[]
6+
endif::[]
7+
38
TODO: Add general description.
49

510
osi_common.proto::

‎doc/architecture/reference_points_coordinate_systems.adoc

+5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
= Coordinate systems, reference points and coordinate transformation
22

3+
ifndef::include-only-once[]
4+
:root-path: ../
5+
include::{root-path}_config.adoc[]
6+
endif::[]
7+
38
OSI uses DIN ISO 8855:2013-11 cite:[iso8855] for coordinate systems and transformations between coordinate systems.
49
OSI uses three coordinate systems:
510

‎doc/architecture/sensor_data.adoc

+5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
= Sensor data
22

3+
ifndef::include-only-once[]
4+
:root-path: ../
5+
include::{root-path}_config.adoc[]
6+
endif::[]
7+
sw
38
`SensorData` messages imitate the output of real sensors.
49
They can be generated from `GroundTruth` messages, `SensorView` messages, `FeatureData` messages, or `SensorData` messages.
510
With the exception of feature data, all information regarding the environment is given with respect to the virtual sensor coordinate system.

‎doc/architecture/sensor_model.adoc

+5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
= Sensor model
22

3+
ifndef::include-only-once[]
4+
:root-path: ../
5+
include::{root-path}_config.adoc[]
6+
endif::[]
7+
38
Sensor models consume `SensorView` messages and produce `SensorData` messages.
49
Sensor-model output does not represent raw data but detected features or classified objects.

‎doc/architecture/sensor_view.adoc

+5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
= Sensor view
22

3+
ifndef::include-only-once[]
4+
:root-path: ../
5+
include::{root-path}_config.adoc[]
6+
endif::[]
7+
38
The sensor view provides the input to OSI sensor models.
49
`SensorView` messages are derived from `GroundTruth` messages.
510
All information regarding the environment is given with respect to the virtual sensor coordinate system, with two exceptions:

‎doc/architecture/sensor_view_configuration.adoc

+5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
= Sensor-view configuration
22

3+
ifndef::include-only-once[]
4+
:root-path: ../
5+
include::{root-path}_config.adoc[]
6+
endif::[]
7+
38
The sensor view is flexibly defined to provide different kinds of sensor models with an appropriate input.
49
The sensor-view configuration defines the configuration of a particular sensor view.
510

‎doc/architecture/test_scripts.adoc

+5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
= Test scripts
22

3+
ifndef::include-only-once[]
4+
:root-path: ../
5+
include::{root-path}_config.adoc[]
6+
endif::[]
7+
38
TODO: Add general description.
49

510
__init__.py::

‎doc/architecture/trace_file_formats.adoc

+5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
= OSI trace file formats
22

3+
ifndef::include-only-once[]
4+
:root-path: ../
5+
include::{root-path}_config.adoc[]
6+
endif::[]
7+
38
There are multiple formats for storing multiple serialized OSI messages in one trace file.
49

510
*.osi::

‎doc/architecture/trace_file_naming.adoc

+5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
= OSI trace file naming conventions
22

3+
ifndef::include-only-once[]
4+
:root-path: ../
5+
include::{root-path}_config.adoc[]
6+
endif::[]
7+
38
**Name format**
49

510
The names of OSI trace files should have the following format:

‎doc/architecture/traffic_command.adoc

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
11
= Traffic command
22

3+
ifndef::include-only-once[]
4+
:root-path: ../
5+
include::{root-path}_config.adoc[]
6+
endif::[]
7+
8+
39
`TrafficCommand` messages contain control commands from the scenario engine to traffic participant models.

‎doc/architecture/traffic_participant.adoc

+5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
= Traffic participant
22

3+
ifndef::include-only-once[]
4+
:root-path: ../
5+
include::{root-path}_config.adoc[]
6+
endif::[]
7+
38
A traffic participant is an element of the simulated world and can change its state during simulation time, for example, its position and orientation.
49
A traffic participant represents one of the following:
510

‎doc/architecture/traffic_update.adoc

+5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
= Traffic update
22

3+
ifndef::include-only-once[]
4+
:root-path: ../
5+
include::{root-path}_config.adoc[]
6+
endif::[]
7+
38
`TrafficUpdate` messages are provided by traffic participants.
49
They provide updates on the position, state, and future trajectory of a traffic participant back to the simulation environment.

‎doc/architecture/vehicle_dynamics.adoc

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
11
= Vehicle dynamics
22

3+
ifndef::include-only-once[]
4+
:root-path: ../
5+
include::{root-path}_config.adoc[]
6+
endif::[]
7+
38
TODO: Content to be added in future release.

‎doc/misc/osi_vision.adoc

+5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
= Idea behind Open Simulation Interface
22

3+
ifndef::include-only-once[]
4+
:root-path: ../
5+
include::{root-path}_config.adoc[]
6+
endif::[]
7+
38
{THIS_STANDARD} Open Simulation Interface is a specification for interfaces between models and components of a distributed simulation.
49
OSI is strongly focused on the environmental perception of automated driving functions.
510
However, OSI also specifies interfaces for modeling traffic participants.

‎doc/open-simulation-interface_user_guide.adoc

+7-17
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,9 @@
1-
ifndef::THIS_STANDARD[]
2-
3-
:asciidoc-resources: ../asciidoc-resources
4-
include::{asciidoc-resources}/preamble.adoc[]
5-
6-
:revnumber: --localbuild--
7-
:revdate: {docdate}
8-
9-
:topicdir: topics
10-
:reusedir: reuse
11-
12-
:imagesdir: .
13-
:images_open_simulation_interface: ./images
14-
15-
16-
endif::[]
17-
1+
:root-path: ./
2+
include::{root-path}_config.adoc[]
183
= Open Simulation Interface
194

5+
:antora_mapping: title;numbered
6+
ifndef::use-antora-rules[]
207

218
include::./misc/osi_vision.adoc[leveloffset=+1]
229

@@ -115,3 +102,6 @@ include::./setup/installing_windows_python.adoc[leveloffset=+2]
115102
//== Improving performance
116103

117104
//TODO: Define topics and issues regarding performance.
105+
106+
endif::[]
107+
:!antora-mapping:

‎doc/setup/including_osi_dev_projects.adoc

+5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
= Including OSI in development projects
22

3+
ifndef::include-only-once[]
4+
:root-path: ../
5+
include::{root-path}_config.adoc[]
6+
endif::[]
7+
38
TODO: Content to be added in future release.
49

510
// TODO: Add description of this task.

‎doc/setup/installing_linux_cpp.adoc

+5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
= Installing OSI for C++ on Linux
22

3+
ifndef::include-only-once[]
4+
:root-path: ../
5+
include::{root-path}_config.adoc[]
6+
endif::[]
7+
38
**Prerequisites**
49

510
* You have installed _cmake_.

0 commit comments

Comments
 (0)