Merge pull request #19 from SimonGrimmACS/master

deploy CIM++ doxygen documentation to github pages
sogno-platform · Jul 7, 2022 · 09c4006 · 09c4006
2 parents c7824c6 + b2d05b5
commit 09c4006
Show file tree

Hide file tree

Showing 7 changed files with 140 additions and 30 deletions.
diff --git a/.github/workflows/build-doc.yml b/.github/workflows/build-doc.yml
@@ -1,6 +1,7 @@
 name: build-doc
 
-on: [push]
+on: workflow_dispatch
+
 
 jobs:
 

diff --git a/.github/workflows/build-gh-pages.yml b/.github/workflows/build-gh-pages.yml
@@ -0,0 +1,94 @@
+name: build-gh-pages
+
+on: [push]
+#on: workflow_dispatch
+
+jobs:
+   build-gh-pages:
+
+    runs-on: ubuntu-latest
+    env:
+      USE_CIM_VERSION1: IEC61970_16v29a_IEC61968_12v08
+      USE_CIM_VERSION2: IEC61970_16v29a
+      USE_CIM_VERSION3: IEC61970_17v07
+      USE_CIM_VERSION4: CGMES_2.4.15_27JAN2020
+    steps:
+    - uses: actions/checkout@v2    
+    - name: Checkout submodules
+      run: git submodule update --init --recursive
+    - name: Install Doxygen
+      run: sudo apt-get install doxygen 
+      shell: bash 
+    - name: CIM1 Create Build Environment 
+      run: cmake -E make_directory ${{runner.workspace}}/libcimpp/build/${{env.USE_CIM_VERSION1}}      
+    - name: CIM1 Configure CMake and compile
+      shell: bash
+      working-directory: ${{runner.workspace}}/libcimpp/build/${{env.USE_CIM_VERSION1}}/
+      run: |
+          cd ${{runner.workspace}}/libcimpp/build/${{env.USE_CIM_VERSION1}} 
+          cmake ../.. -DUSE_CIM_VERSION=${{env.USE_CIM_VERSION1}}
+          make doc
+         
+    - name: CIM1 Copy 
+      run: |
+          mkdir -p ./copy_files/docs
+          cp -r ${{runner.workspace}}/libcimpp/build/${{env.USE_CIM_VERSION1}}/doc/html ./copy_files/docs/${{env.USE_CIM_VERSION1}}
+          
+        
+    - name: CIM2 Create Build Environment 
+      run: cmake -E make_directory ${{runner.workspace}}/libcimpp/build/${{env.USE_CIM_VERSION2}}
+
+    - name: CIM2 Configure CMake and compile
+      shell: bash
+      working-directory: ${{runner.workspace}}/libcimpp/build/${{env.USE_CIM_VERSION2}}/
+      run: |
+          cd ${{runner.workspace}}/libcimpp/build/${{env.USE_CIM_VERSION2}} 
+          cmake ../.. -DUSE_CIM_VERSION=${{env.USE_CIM_VERSION2}}
+          make doc
+    - name: CIM2 Copy
+      run: |
+          mkdir -p ./copy_files/docs
+          cp -r ${{runner.workspace}}/libcimpp/build/${{env.USE_CIM_VERSION2}}/doc/html ./copy_files/docs/${{env.USE_CIM_VERSION2}}
+   
+    - name: CIM3 Create Build Environment
+      run: cmake -E make_directory ${{runner.workspace}}/libcimpp/build/${{env.USE_CIM_VERSION3}}
+
+    - name: CIM3 Configure CMake and compile
+      shell: bash
+      working-directory: ${{runner.workspace}}/libcimpp/build/${{env.USE_CIM_VERSION3}}/
+      run: |
+          cd ${{runner.workspace}}/libcimpp/build/${{env.USE_CIM_VERSION3}} 
+          cmake ../.. -DUSE_CIM_VERSION=${{env.USE_CIM_VERSION3}}
+          make doc
+    - name: CIM3 Copy 
+      run: |
+          mkdir -p ./copy_files/docs
+          cp -r ${{runner.workspace}}/libcimpp/build/${{env.USE_CIM_VERSION3}}/doc/html ./copy_files/docs/${{env.USE_CIM_VERSION3}}  
+  
+
+    - name: CIM4 Create Build Environment 
+      run: cmake -E make_directory ${{runner.workspace}}/libcimpp/build/${{env.USE_CIM_VERSION4}}
+
+    - name: CIM4 Configure CMake and compile
+      shell: bash
+      working-directory: ${{runner.workspace}}/libcimpp/build/${{env.USE_CIM_VERSION4}}/
+      run: |
+          cd ${{runner.workspace}}/libcimpp/build/${{env.USE_CIM_VERSION4}} 
+          cmake ../.. -DUSE_CIM_VERSION=${{env.USE_CIM_VERSION4}}
+          make doc
+    - name: CIM4 Copy
+      run: |
+          mkdir -p ./copy_files/docs
+          cp -r ${{runner.workspace}}/libcimpp/build/${{env.USE_CIM_VERSION4}}/doc/html ./copy_files/docs/${{env.USE_CIM_VERSION4}}  
+          cp ./README.md ./copy_files/docs/README.md
+             
+    - name: Deploy
+      uses: peaceiris/actions-gh-pages@v3      
+      with:        
+        github_token: ${{ secrets.GITHUB_TOKEN }}     
+        publish_dir: ./copy_files
+        force_orphan: true
+        keep_files: false
+        publish_branch: gh-pages
+
+
diff --git a/.github/workflows/build-src.yml b/.github/workflows/build-src.yml
@@ -1,6 +1,7 @@
 name: build-src
 
-on: [push]
+#on: [push]
+on: workflow_dispatch
 
 
 jobs:
@@ -25,7 +26,7 @@ jobs:
       run: |
           cd ${{runner.workspace}}/libcimpp/build/${{env.USE_CIM_VERSION}} 
           cmake ../.. -DUSE_CIM_VERSION=${{env.USE_CIM_VERSION}}
-          make -j8
+          make -j4
 
 
 
@@ -49,7 +50,7 @@ jobs:
       run: |
           cd ${{runner.workspace}}/libcimpp/build/${{env.USE_CIM_VERSION}} 
           cmake ../.. -DUSE_CIM_VERSION=${{env.USE_CIM_VERSION}}
-          make -j8
+          make -j4
 
   build-src-IEC61970_16v29a_IEC61968_12v08:
     runs-on: ubuntu-latest
@@ -71,7 +72,7 @@ jobs:
       run: |
           cd ${{runner.workspace}}/libcimpp/build/${{env.USE_CIM_VERSION}} 
           cmake ../.. -DUSE_CIM_VERSION=${{env.USE_CIM_VERSION}}
-          make -j8
+          make -j4
 
 
   build-src-CGMES_2-4-15_27JAN2020:
@@ -95,5 +96,5 @@ jobs:
       run: |
           cd ${{runner.workspace}}/libcimpp/build/${{env.USE_CIM_VERSION}} 
           cmake ../.. -DUSE_CIM_VERSION=${{env.USE_CIM_VERSION}}
-          make -j8
+          make -j4
 
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -2,27 +2,8 @@ cmake_minimum_required(VERSION 3.5)
 
 project(libcimpp CXX)
 set(CMAKE_CXX_STANDARD 11)
-
 set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_CURRENT_SOURCE_DIR}/cmake/" "${CMAKE_CURRENT_SOURCE_DIR}/../../cmake")
 
-add_subdirectory(doc)
-add_subdirectory(thirdparty)
-
-set(libcimpp_MAJOR_VERSION 2)
-set(libcimpp_MINOR_VERSION 1)
-set(libcimpp_PATCH_VERSION 0)
-set(libcimpp_VERSION ${libcimpp_MAJOR_VERSION}.${libcimpp_MINOR_VERSION}.${libcimpp_PATCH_VERSION})
-
-# Options
-option(BUILD_SHARED_LIBS "Build shared library" OFF)
-option (BUILD_EXAMPLES "Build examples" OFF)
-
-if(NOT USE_CIM_VERSION)
-	set(USE_CIM_VERSION "CGMES_2.4.15_27JAN2020" CACHE STRING "Define CIM Version")
-endif()
-
-message(STATUS "Building ${PROJECT_NAME} with USE_CIM_VERSION=${USE_CIM_VERSION}")
-
 if(USE_CIM_VERSION STREQUAL "CGMES_2.4.15_27JAN2020")
   set(CGMES_BUILD ON)
   set(CIM_NAME "CGMES 2_4_15 27_01_2020")
@@ -46,6 +27,26 @@ else()
   message(FATAL_ERROR "${USE_CIM_VERSION} is an invalid value for USE_CIM_VERSION")
 endif()
 
+
+add_subdirectory(doc)
+add_subdirectory(thirdparty)
+
+set(libcimpp_MAJOR_VERSION 2)
+set(libcimpp_MINOR_VERSION 1)
+set(libcimpp_PATCH_VERSION 0)
+set(libcimpp_VERSION ${libcimpp_MAJOR_VERSION}.${libcimpp_MINOR_VERSION}.${libcimpp_PATCH_VERSION})
+
+# Options
+option(BUILD_SHARED_LIBS "Build shared library" OFF)
+option (BUILD_EXAMPLES "Build examples" OFF)
+
+if(NOT USE_CIM_VERSION)
+	set(USE_CIM_VERSION "CGMES_2.4.15_27JAN2020" CACHE STRING "Define CIM Version")
+endif()
+
+message(STATUS "Building ${PROJECT_NAME} with USE_CIM_VERSION=${USE_CIM_VERSION}")
+
+
 # Uncomment this if you are developing on CIMgen and want to generate CIM c++
 #if(CGMES_BUILD)
 #  set(CGMES_OUTPUT_FOLDER ${CMAKE_CURRENT_SOURCE_DIR}/${CIM_FOLDER})

diff --git a/README.md b/README.md
@@ -1,7 +1,20 @@
 libcimpp
 ========
 libcimpp is a deserialiser library for C++ objects from XML/RDF documents based on the Common Information Model (CIM) standards (i.e. IEC61970/61968/62325) for the energy sector.
-It is part of the CIM++ project. More on CIM++ can be found [here](http://rdcu.be/vOop) and on the CIM++ [HomePage](http://fein-aachen.org/projects/cimpp).
+It is part of the CIM++ project. More on CIM++ can be found [here](http://rdcu.be/vOop).
+
+CIM C++ Codebases adaptiert durch CIM++
+Originale CIM Versionen
+
+
+[IEC61970 16v29a](https://sogno-platform.github.io/libcimpp/IEC61970_16v29a/annotated.html)
+
+[ICGMES_2.4.15_27JAN2020](https://sogno-platform.github.io/libcimpp/CGMES_2.4.15_27JAN2020/annotated.html)
+
+[IEC61970_16v29a_IEC61968_12v08](https://sogno-platform.github.io/libcimpp/IEC61970_16v29a_IEC61968_12v08/annotated.html)
+
+[IEC61970_17v07](https://sogno-platform.github.io/libcimpp/IEC61970_17v07/annotated.html)
+
 
 ## General information
 limcimpp uses [arabica](http://www.jezuk.co.uk/cgi-bin/view/arabica) as cross platform wrapper around one of the XML parsers listed int the dependencies (see below).
@@ -64,4 +77,4 @@ To be continued...
 ## Usage of the libcimpp library
 For information how to use the library please see the [cmake based example](https://git.rwth-aachen.de/acs/core/cim/cimpp/libcimpp/tree/master/examples/cmake).
 Building of the example can be performed analogous to bulding the library itself (as described in the *Build instructions* above).<br>
-The pure make example is currently not supported due to the lack of an install target for arabica.
+The pure make example is currently not supported due to the lack of an install target for arabica.
diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in
@@ -1,8 +1,8 @@
-PROJECT_NAME = "@CIM_NAME@"
+PROJECT_NAME = @CIM_NAME@
 PROJECT_LOGO = doc/cimpp.svg
 
 OUTPUT_DIRECTORY = @CMAKE_CURRENT_BINARY_DIR@
-INPUT = src @CIM_FOLDER@ README.md
+INPUT = src @USE_CIM_VERSION@ README.md
 INCLUDE_PATH = src
 
 GENERATE_LATEX = NO

diff --git a/doc/header.html b/doc/header.html
@@ -27,7 +27,7 @@
  <tr style="height: 56px;">
   <!--BEGIN PROJECT_LOGO-->
   <td id="projectlogo" class="logo" style="padding-top: 0.5em; padding-left 0.75em;">
-    <a href="https://www.fein-aachen.org/projects/cimpp/" target="_blank">
+    <a href="https://sogno-platform.github.io/libcimpp/" target="_blank">
        <img alt="Logo" src="$relpath^$projectlogo" height="80"/>
     </a>
   </td>