File tree Expand file tree Collapse file tree 2 files changed +27
-1
lines changed Expand file tree Collapse file tree 2 files changed +27
-1
lines changed Original file line number Diff line number Diff line change @@ -17,7 +17,24 @@ Pipeline is broken - `OSI Validation`_
1717
1818|osi_sensor_model_packaging_build | - `OSI Model Packaging `_
1919
20-
20+ How To build and change Documentation locally on Windows
21+ --------------------------------------------------------
22+ - Install Docker Desktop
23+ - Clone this repository with submodules
24+ - Clone OSI and OSMP with submodules into this folder
25+ - Check file ``docker-compose.yml `` with the following content:
26+
27+ .. code-block :: yaml
28+
29+ version : " 2"
30+
31+ services :
32+ asciidoctor :
33+ image : asciidoctor/docker-asciidoctor:1
34+ volumes :
35+ - .:/documents
36+ working_dir : /documents
37+ 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
2138
2239 .. _Open Simulation Interface : https://opensimulationinterface.github.io/osi-documentation/open-simulation-interface/README.html
2340.. _OSI Validation : https://opensimulationinterface.github.io/osi-documentation/osi-validation/README.html
Original file line number Diff line number Diff line change 1+ version : " 2"
2+
3+ services :
4+ asciidoctor :
5+ image : asciidoctor/docker-asciidoctor:1
6+ volumes :
7+ - .:/documents
8+ working_dir : /documents
9+ 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
You can’t perform that action at this time.
0 commit comments