Adding Documenter.jl documentation (#92)

* Adding Documenter.jl documentation

* Updating README

* Use log files for OMCSession creation to prevent Documenter.jl to get stuck

---------

Co-authored-by: arun3688 <[email protected]>

.github/workflows/Test.yml

@@ -19,7 +19,7 @@ jobs:
         omc-version: ['stable']
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: "Set up OpenModelica Compiler"
         uses: AnHeuermann/[email protected]
@@ -38,6 +38,9 @@ jobs:
           version: ${{ matrix.julia-version }}
           arch: ${{ matrix.julia-arch }}
 
+      - name: Cache Julia
+        uses: julia-actions/cache@v1
+
       - name: "Build OMJulia"
         uses: julia-actions/julia-buildpkg@v1
 

.github/workflows/documentation.yml

@@ -0,0 +1,47 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - master
+    tags: '*'
+  pull_request:
+
+jobs:
+  build:
+    permissions:
+      contents: write
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        julia-version: ['1.9']
+        julia-arch: [x64]
+        os: [ubuntu-latest]
+    timeout-minutes: 60
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup OpenModelica
+        uses: AnHeuermann/[email protected]
+        with:
+          version: 'nightly'
+          packages: |
+            'omc'
+
+      - name: Setup Julia
+        uses: julia-actions/setup-julia@v1
+        with:
+          version: ${{ matrix.julia-version }}
+          arch: ${{ matrix.julia-arch }}
+
+      - name: Cache Julia
+        uses: julia-actions/cache@v1
+
+      - name: Install dependencies
+        run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
+
+      - name: Build and deploy
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # If authenticating with GitHub Actions token
+        run: julia --project=docs/ docs/make.jl

README.md

@@ -1,6 +1,8 @@
-# OMJulia
+# OMJulia.jl
 
-Julia scripting [OpenModelica](https://openmodelica.org/) interface.
+*Julia scripting [OpenModelica](https://openmodelica.org/) interface.*
+
+[![][docs-dev-img]][docs-dev-url] [![][GHA-test-img]][GHA-test-url]
 
 ## Requirements
 
@@ -17,11 +19,6 @@ Install OMJulia.jl with:
 julia> import Pkg; Pkg.add("OMJulia")
 ```
 
-## Documentation
-
-To see the list advanced API, the information are provided in the
-[OpenModelica User's Guide](https://www.openmodelica.org/doc/OpenModelicaUsersGuide/latest/omjulia.html).
-
 ## Usage
 
 ```julia
@@ -80,3 +77,9 @@ This program is distributed WITHOUT ANY WARRANTY; without even the implied
 warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, EXCEPT AS
 EXPRESSLY SET FORTH IN THE BY RECIPIENT SELECTED SUBSIDIARY LICENSE
 CONDITIONS OF OSMC-PL.
+
+[docs-dev-img]: https://img.shields.io/badge/docs-dev-blue.svg
+[docs-dev-url]: https://OpenModelica.github.io/OMJulia.jl/dev/
+
+[GHA-test-img]: https://github.com/OpenModelica/OMJulia.jl/actions/workflows/Test.yml/badge.svg?branch=master
+[GHA-test-url]: https://github.com/OpenModelica/OMJulia.jl/actions/workflows/Test.yml

docs/.gitignore

@@ -0,0 +1,2 @@
+/build/
+/omc-temp/