https://opensimulationinterface.github.io/osi-documentation/
This is the official main documentation for the open-simulation-interface organization based on sphinx
https://opensimulationinterface.github.io/osi-documentation/
asam open-simulation-interface osi
Last synced: 8 months ago
JSON representation
This is the official main documentation for the open-simulation-interface organization based on sphinx
- Host: GitHub
- URL: https://opensimulationinterface.github.io/osi-documentation/
- Owner: OpenSimulationInterface
- License: other
- Created: 2019-09-03T11:37:14.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-07-15T13:16:09.000Z (about 1 year ago)
- Last Synced: 2024-07-15T18:14:41.872Z (about 1 year ago)
- Topics: asam, open-simulation-interface, osi
- Language: TeX
- Homepage:
- Size: 25.6 MB
- Stars: 14
- Watchers: 11
- Forks: 7
- Open Issues: 9
-
Metadata Files:
- Readme: README.adoc
- License: LICENSE
Awesome Lists containing this project
- awesome-openx - Open Simulation Interface (OSI) - Generic interface based on [protobuf](https://github.com/protocolbuffers/protobuf) for the environmental perception of automated driving functions in virtual scenarios. ([Source Code](https://github.com/OpenSimulationInterface/open-simulation-interface)) `MPL-2.0` (Data Structures & Models)
README
= OSI Documentation
This repo hosts the AsciiDoc-based part of the documentation.
It contains generals parts of the content and a CI-pipeline that renders the document with Antora.
// TODO: Update if Asciidoctor is completely dropped!
== ASAM OSI (R) official documentation
See the documentation https://opensimulationinterface.github.io/osi-antora-generator/asamosi/latest/specification/index.html[here].
== Build pipeline
// === Asciidoctor pipeline
// The Asciidoctor pipline is no longer active, see Antora pipeline.
// image::https://github.com/OpenSimulationInterface/osi-documentation/actions/workflows/asciidoc-build.yml/badge.svg[link=https://github.com/OpenSimulationInterface/osi-documentation/actions/workflows/asciidoc-build.yml]
// The pipeline collects the documentation from both https://github.com/OpenSimulationInterface/open-simulation-interface[open-simulation-interface] and https://github.com/OpenSimulationInterface/osi-sensor-model-packaging[osi-sensor-model-packaging] and integrates it into skeleton of this repo.
// As with all ASAM Asciidoctor projects, the complete document structure is described in the mapping file https://github.com/OpenSimulationInterface/osi-documentation/blob/master/index.adoc[index.adoc].
=== Antora pipeline
image::https://github.com/OpenSimulationInterface/osi-antora-generator/actions/workflows/site-build.yml/badge.svg?branch=main[link=https://github.com/OpenSimulationInterface/osi-antora-generator/actions/workflows/site-build.yml]
NOTE: This pipeline runs on https://github.com/OpenSimulationInterface/osi-antora-generator.
== How To build and change documentation locally
IMPORTANT: These instructions relate ONLY to the Asciidoctor build.
For Antora, check the https://github.com/OpenSimulationInterface/osi-antora-generator[ASAM OSI Antora generator].
The following instructions show how to build the document locally.
Take note that the document is built with a version 'localbuild' in the document and filename.
The instruction should work on Windows, Linux, and MacOS.
. *Precondition*: have docker and docker-compose installed.
+
TIP: Official installation can be found https://docs.docker.com/get-docker/[here].
. Clone this repository with submodules.
+
[source, shell]
----
git clone https://github.com/OpenSimulationInterface/osi-documentation.git
git submodule update --init
----
. Clone OSI and OSMP with submodules *into* the osi-documentation folder
+
[source, shell]
----
cd osi-documentation
git clone https://github.com/OpenSimulationInterface/open-simulation-interface.git
git clone https://github.com/OpenSimulationInterface/osi-sensor-model-packaging.git
----
. Check file ``docker-compose.yml`` with the following content:
+
[source, yaml]
----
version: "2"
services:
asciidoctor:
image: asciidoctor/docker-asciidoctor:1
volumes:
- .:/documents
working_dir: /documents
entrypoint: asciidoctor -D . --failure-level WARN -r asciidoctor-bibtex -r asciidoctor-diagram -a mathjax --trace --backend=html5 index.adoc -o open-simulation-interface_localbuild.html
----
. Run
+
[source, shell]
----
docker-compose run asciidoctor
----
. *Result*: Document is build as `open-simulation-interface_localbuild.html` in the folder osi-documentation.