|
| 1 | += OSI Documentation |
| 2 | + |
| 3 | +This repo hosts the asciidoc-based part of the documentation. |
| 4 | +It contains generals parts of the content and a CI-pipeline that renders the document and deploys it the the https://opensimulationinterface.github.io/osi-documentation/[gh-pages of this repo]. |
| 5 | + |
| 6 | +== ASAM OSI (R) official documentation |
| 7 | + |
| 8 | +See the documentation https://opensimulationinterface.github.io/osi-documentation/[here]. |
| 9 | + |
| 10 | + |
| 11 | +== Build Pipeline |
| 12 | + |
| 13 | + |
| 14 | +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] |
| 15 | + |
| 16 | + |
| 17 | +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 asciidoc project the complete document structure is described in the mapping file https://github.com/OpenSimulationInterface/osi-documentation/blob/master/index.adoc[index.adoc]. |
| 18 | + |
| 19 | + |
| 20 | +== How To build and change documentation locally |
| 21 | + |
| 22 | +The following instruction shows how to build the document locally. Take note that the document is build with a version 'localbuild' in the document and filename. |
| 23 | + |
| 24 | +The instruction should work on Windows, Linux and MacOS. |
| 25 | + |
| 26 | +. *Precondition*: have docker and docker-compose installed. |
| 27 | ++ |
| 28 | +TIP: Official installation can be found https://docs.docker.com/get-docker/[here]. |
| 29 | + |
| 30 | +. Clone this repository with submodules. |
| 31 | ++ |
| 32 | +[source, shell] |
| 33 | +---- |
| 34 | +git clone https://github.com/OpenSimulationInterface/osi-documentation.git |
| 35 | +git submodule update --init |
| 36 | +---- |
| 37 | + |
| 38 | +. Clone OSI and OSMP with submodules *into* the osi-documentation folder |
| 39 | ++ |
| 40 | +[source, shell] |
| 41 | +---- |
| 42 | +cd osi-documentation |
| 43 | +git clone https://github.com/OpenSimulationInterface/open-simulation-interface.git |
| 44 | +git clone https://github.com/OpenSimulationInterface/osi-sensor-model-packaging.git |
| 45 | +---- |
| 46 | + |
| 47 | +. Check file ``docker-compose.yml`` with the following content: |
| 48 | ++ |
| 49 | +[source, yaml] |
| 50 | +---- |
| 51 | + version: "2" |
| 52 | + |
| 53 | + services: |
| 54 | + asciidoctor: |
| 55 | + image: asciidoctor/docker-asciidoctor:1 |
| 56 | + volumes: |
| 57 | + - .:/documents |
| 58 | + working_dir: /documents |
| 59 | + 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 |
| 60 | +---- |
| 61 | + |
| 62 | +. Run |
| 63 | ++ |
| 64 | +[source, shell] |
| 65 | +---- |
| 66 | +docker-compose run asciidoctor |
| 67 | +---- |
| 68 | + |
| 69 | +. *Result*: Document is build as `open-simulation-interface_localbuild.html` in the folder osi-documentation. |
0 commit comments