Skip to content

Commit 1241cec

Browse files
philipwindeckerphilipwindecker
authored
Merge pull request #85 from OpenSimulationInterface/antora/base-antora-setup
Build: Create base Antora setup
2 parents 1e35638 + c0f93f3 commit 1241cec

24 files changed

Lines changed: 177 additions & 17 deletions

‎.antora/antora.yml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
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(*)-antora: V$1
7+
v(*): V$1
8+
V(*): V$1
9+
# 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/")
10+
(*): 'V3.6.0-$1'

‎.antora/modules/sensor-model/nav.adoc‎

Lines changed: 22 additions & 0 deletions
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/sensor-model/pages‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../doc

‎README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ The specification can be found in the [doc/osi-sensor-model-packaging_spec.adoc]
77

88
For more detailed information see the [official documentation](https://opensimulationinterface.github.io/osi-documentation/#_osi_sensor_model_packaging).
99

10+
<!-- TODO: Update link with new Antora hosting -->
11+
1012
[Open Simulation Interface (OSI)]: https://github.com/OpenSimulationInterface/open-simulation-interface
1113

1214
## Usage

‎doc/_config.adoc‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
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+
:appendix-caption: Annex
10+
11+
// ifndef::use-antora-rules,include-only-once[]
12+
ifndef::include-only-once[]
13+
:GLO_VAR_STA_ASAM_OpenCRG: ASAM OpenCRG
14+
:glo_var_sta_asam_opencrg: {GLO_VAR_STA_ASAM_OpenCRG}
15+
:GLO_VAR_STA_ASAM_OpenDRIVE: ASAM OpenDRIVE
16+
:GLO_VAR_STA_ASAM_OpenLABEL: ASAM OpenLABEL
17+
:GLO_VAR_STA_ASAM_OpenODD: ASAM OpenODD
18+
:GLO_VAR_STA_ASAM_OSI: ASAM OSI®
19+
:GLO_VAR_STA_ASAM_OpenSCENARIO: ASAM OpenSCENARIO
20+
:GLO_VAR_STA_ASAM_OpenXOntology: ASAM OpenXOntology
21+
:GLO_VAR_STA_BSI_PAS_1883: BSI PAS 1883
22+
:revnumber: --localbuild--
23+
:revdate: {docdate}
24+
:bibtex-file: ./content/general_docs/bibliography.bib
25+
// Replace PLACEHOLDER with the name of your standard, e.g. OpenDRIVE
26+
:THIS_STANDARD: {GLO_VAR_STA_ASAM_OSI}
27+
:asam-terminology: https://code.asam.net/common/asam-terminology/-/raw/main/terms_and_definitions_opendrive.adoc
28+
:imagesdir: {root-path}/images
29+
:include-only-once: true
30+
:topicdir: topics
31+
:reusedir: reuse
32+
:toclevels: 3
33+
:xrefstyle: full
34+
:images_open_simulation_interface: ./open-simulation-interface/doc/images
35+
// :images_osi-sensor-model-packaging: ./osi-sensor-model-packaging/doc/images
36+
:doc_open_simulation_interface: ../../open-simulation-interface/doc/
37+
:doc_osi-sensor-model-packaging: ../../osi-sensor-model-packaging/doc/
38+
// Since a document spanning multiple repos is rendered here, the pathing regarding images is a bit involved.
39+
// We create a variable for every repo that is included. It point to the repo in question.
40+
// If the subrepo is rendered seperatly, then the variable is set to just "./images" with ifdef.
41+
// Please note that this variable has to used in all image includes. Includes here have to use "image::./images..."
42+
// :images_osi_sensor_model_packaging: ./osi-sensor-model-packaging/doc/images // example
43+
:imagesoutdir: ./images/generated_images
44+
:page-feedbackurl: https://github.com/OpenSimulationInterface/osi-sensor-model-packaging/issues/new
45+
46+
47+
endif::[]
48+
49+
50+
ifdef::env-gitlab[]
51+
:relfilesuffix: .adoc
52+
endif::[]

‎doc/misc/example.adoc‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
ifndef::include-only-once[]
2+
:root-path: ../
3+
include::{root-path}_config.adoc[]
4+
endif::[]
15
= Example: Simple sensor model FMU
26

37
The following example shows the content of a `modelDescription.xml` file that satisfies OSMP requirements.

‎doc/misc/introduction.adoc‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
ifndef::include-only-once[]
2+
:root-path: ../
3+
include::{root-path}_config.adoc[]
4+
endif::[]
15
= Introduction
26

37
_OSI Sensor Model Packaging_ (OSMP) is a package layer specification for the _Open Simulation Interface_ (OSI).

‎doc/osi-sensor-model-packaging_spec.adoc‎

Lines changed: 6 additions & 17 deletions
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
= OSI Sensor Model Packaging
194

5+
:antora_mapping: title;numbered
6+
ifndef::use-antora-rules[]
207
include::./misc/introduction.adoc[leveloffset=+1]
218

229
== OSMP specification
@@ -51,3 +38,5 @@ include::./setup/build_install_example.adoc[leveloffset=+2]
5138

5239
include::./misc/example.adoc[leveloffset=+2]
5340

41+
endif::[]
42+
:!antora-mapping:

‎doc/setup/build_install_example.adoc‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
ifndef::include-only-once[]
2+
:root-path: ../
3+
include::{root-path}_config.adoc[]
4+
endif::[]
15
= Building and installing examples
26

37
OSMP includes three examples located in `_osmp_/examples`:

‎doc/spec/basic_conventions.adoc‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
ifndef::include-only-once[]
2+
:root-path: ../
3+
include::{root-path}_config.adoc[]
4+
endif::[]
15
= Basic conventions
26

37
The model shall be packaged as a valid FMU for co-simulation, as specified in the FMI 2.0 standard cite:[fmi2.0].

0 commit comments

Comments
 (0)