Merge branch 'OpenSimulationInterface:master' into master

Author: philipwindecker

.antora/antora.yml

@@ -36,6 +36,7 @@ asciidoc: # Sets global AsciiDoc attributes that are applied for every page of t
     doc_open_simulation_interface: 'interface:'
     doc_osi-sensor-model-packaging: 'sensor-model:'
     page-repository-links: [["https://github.com/OpenSimulationInterface/open-simulation-interface", "Open Simulation Interface"],["https://github.com/OpenSimulationInterface/osi-sensor-model-packaging","OSI Sensor Model Packaging"],["https://github.com/OpenSimulationInterface/osi-validation","OSI Validation"]]
+    asamBibliography: 'specification:general_docs/bibliography.bib'
 
   # END - Mandatory ASAM attributes
   # doxygen_interface_version: "v3.2.0"  # The interface version that needs to be retrieved

.gitignore

@@ -1,4 +1,5 @@
 vpython/
 _build/
 .vscode/
-_templates/
+_templates/
+local_build_tools/*.html

asciidoc-resources

@@ -36,7 +36,7 @@ ifndef::include-only-once[]
 // :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/
-:images_open_simulation_interface: ../../open-simulation-interface/doc/images
+:images_open_simulation_interface: ../images
 // 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.
@@ -54,3 +54,10 @@ endif::[]
 ifdef::env-gitlab[]
 :relfilesuffix: .adoc
 endif::[]
+
+ifdef::local[]
+:doc_open_simulation_interface: ../../open-simulation-interface/doc/
+:doc_osi-sensor-model-packaging: ../../osi-sensor-model-packaging/doc/
+:images_open_simulation_interface: ../images
+:data-uri:
+endif::[]

content/_config.adoc

@@ -1,7 +1,7 @@
 % Encoding: UTF-8
 
 @Book{fmi2.0,
-  publisher = {Modelica Association, Linköping, Sweden.},
+  publisher = {Modelica Association, Linköping, Sweden},
   title = {FMI 2.0: Functional Mock-up Interface for Model Exchange and Co-Simulation},
   year = {2014-07},
 }
@@ -13,19 +13,19 @@ @Book{IEEE_754-2019
 }
 
 @Book{iso23150,
-  publisher = {International Organization for Standardization, Geneva, Switzerland.},
+  publisher = {International Organization for Standardization, Geneva, Switzerland},
   title     = {ISO 23150:2021 Road vehicles — Data communication between sensors and data fusion unit for automated driving functions — Logical interface},
   year      = {2021-05},
   }
 
 @Book{iso8601,
-  publisher = {International Organization for Standardization, Geneva, Switzerland.},
+  publisher = {International Organization for Standardization, Geneva, Switzerland},
   title     = {ISO 8601:2019 Data elements and interchange formats — Information interchange — Representation of dates and times},
   year      = {2004-12},
 }
 
 @Book{iso8855,
-  publisher = {Deutsches Institut für Normung e.V., Berlin, Germany.},
+  publisher = {Deutsches Institut für Normung e.V., Berlin, Germany},
   title     = {DIN ISO 8855:2013-11 Road vehicles - Vehicle dynamics and road-holding ability - Vocabulary},
   year      = {2013-11},
 }
@@ -49,28 +49,28 @@ @Book{openscenario
 }
 
 @Book{protobuf,
-  publisher = {https://developers.google.com/protocol-buffers/.},
-  title     = {Protocol Buffers.},
+  publisher = {https://developers.google.com/protocol-buffers/},
+  title     = {Protocol Buffers},
   year      = {2008-07},
 }
 
 @Book{wiki_rotation_matrix,
-  publisher = {https://en.wikipedia.org/wiki/Rotation_matrix.},
-  title     = {Rotation Matrix.},
+  publisher = {https://en.wikipedia.org/wiki/Rotation_matrix},
+  title     = {Rotation Matrix},
   year      = {2022-01},
 }
 
 @Book{wiki_euler_angles,
-  publisher = {https://en.wikipedia.org/wiki/Euler_angles.},
-  title     = {Protocol Buffers.},
+  publisher = {https://en.wikipedia.org/wiki/Euler_angles},
+  title     = {Euler Angles},
   year      = {2022-01},
 }
 
 @Book{reuper2020,
-  publisher = {Reuper.},
+  publisher = {Reuper},
   title     = {Multi-Frequency GNSS Sensor Fusion With Quality Assessment for Automotive Applications.},
   year      = {2020},
 }
 
 
-@Comment{jabref-meta: databaseType:bibtex;}
+@Comment{jabref-meta: databaseType:bibtex;}

content/general_docs/bibliography.bib

@@ -43,11 +43,13 @@ include::./general_docs/versioning.adoc[leveloffset=+2]
 include::./general_standard/relations_to_other_standards.adoc[leveloffset=+2]
 
 // START: including the documentation of other osi repositories
-
+:imagesdir: {doc_open_simulation_interface}images
 include::{doc_open_simulation_interface}open-simulation-interface_user_guide.adoc[leveloffset=+1]
 
+:imagesdir: {doc_osi-sensor-model-packaging}images
 include::{doc_osi-sensor-model-packaging}osi-sensor-model-packaging_spec.adoc[leveloffset=+1]
 
+:imagesdir: ./images
 // osi-validation and osi-visualizer are considered supplementary tooling that is not normative. They are therefore not part of the ASAM standard release.
 // include::./osi-validation/doc/osi-validator_user_guide.adoc[leveloffset=+1,opts=optional]
 

content/index.adoc

@@ -5,4 +5,6 @@ services:
     image: asciidoctor/docker-asciidoctor
     volumes:
       - ../:/documents
-    entrypoint: asciidoctor --failure-level WARN -r asciidoctor-kroki -a mathjax -r asciidoctor-bibtex --trace content/index.adoc -o local_build_tools/HTML_content_local_build.html
+      - ../../open-simulation-interface:/open-simulation-interface
+      - ../../osi-sensor-model-packaging:/osi-sensor-model-packaging
+    entrypoint: asciidoctor -a local=true --failure-level WARN -r asciidoctor-kroki -a mathjax -r asciidoctor-bibtex --trace content/index.adoc -o local_build_tools/HTML_content_local_build.html