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.
See the documentation here.
Note
|
This pipeline runs on https://github.com/OpenSimulationInterface/osi-antora-generator. |
Important
|
These instructions relate ONLY to the Asciidoctor build. For Antora, check the 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.
TipOfficial installation can be found here. -
Clone this repository with submodules.
git clone https://github.com/OpenSimulationInterface/osi-documentation.git git submodule update --init
-
Clone OSI and OSMP with submodules into the osi-documentation folder
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: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
docker-compose run asciidoctor
-
Result: Document is build as
open-simulation-interface_localbuild.html
in the folder osi-documentation.