11= OSI Documentation
22
3- This repo hosts the AsciiDoc-based part of the documentation.
3+ This repo contains most of the AsciiDoc-based part of the documentation.
44It contains generals parts of the content and a CI-pipeline that renders the document with Antora.
55
6- // TODO: Update if Asciidoctor is completely dropped!
6+ NOTE: The actual hosting has been moved to the generator repository (see link below).
77
88== ASAM OSI (R) official documentation
99
1010See the documentation https://opensimulationinterface.github.io/osi-antora-generator/asamosi/latest/specification/index.html[here].
1111
1212
13- == Build pipeline
14- // === Asciidoctor pipeline
15-
16- // The Asciidoctor pipline is no longer active, see Antora pipeline.
17-
18- // 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]
19-
20- // 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.
21- // 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].
22-
23- === Antora pipeline
13+ == Antora build pipeline
2414image::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]
2515
2616NOTE: This pipeline runs on https://github.com/OpenSimulationInterface/osi-antora-generator.
2717
28-
2918== How To build and change documentation locally
3019
31- IMPORTANT: These instructions relate ONLY to the Asciidoctor build.
20+ IMPORTANT: These instructions relate ONLY to the Asciidoctor build.
3221For Antora, check the https://github.com/OpenSimulationInterface/osi-antora-generator[ASAM OSI Antora generator].
3322
3423
35- The following instructions show how to build the document locally.
24+ The following instructions show how to build the document locally.
3625Take note that the document is built with a version 'localbuild' in the document and filename.
3726
3827The instruction should work on Windows, Linux, and MacOS.
@@ -41,7 +30,7 @@ The instruction should work on Windows, Linux, and MacOS.
4130+
4231TIP: Official installation can be found https://docs.docker.com/get-docker/[here].
4332
44- . Clone this repository with submodules.
33+ . Clone this repository with submodules.
4534+
4635[source, shell]
4736----
@@ -63,17 +52,17 @@ git clone https://github.com/OpenSimulationInterface/osi-sensor-model-packaging.
6352[source, yaml]
6453----
6554 version: "2"
66-
67- services:
55+
56+ services:
6857 asciidoctor:
6958 image: asciidoctor/docker-asciidoctor:1
70- volumes:
59+ volumes:
7160 - .:/documents
7261 working_dir: /documents
7362 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
7463----
7564
76- . Run
65+ . Run
7766+
7867[source, shell]
7968----
0 commit comments