update ci and doc

Author: 7bitcoder

.github/actions/cmake-build/action.yml

@@ -26,7 +26,25 @@ runs:
   steps:
     - name: Configure CMake
       working-directory: ${{ inputs.build-dir }}
-      run: cmake .. -DCMAKE_BUILD_TYPE=${{ inputs.build-type }} -DLIBRARY_TYPE=${{ inputs.library-type }} -DCMAKE_TOOLCHAIN_FILE:STRING="${{ inputs.toolchain }}" ${{ inputs.args }}
+      run: cmake .. -DCMAKE_BUILD_TYPE=${{ inputs.build-type }} -DSEVEN_BIT_DI_BUILD_SHARED=${{ inputs.build-shared }} -DCMAKE_TOOLCHAIN_FILE:STRING="${{ inputs.toolchain }}" -DSEVEN_BIT_DI_BUILD_TESTS_HO:BOOL=${{ inputs.use-header-only }} -DSEVEN_BIT_DI_BUILD_EXAMPLES_HO:BOOL=${{ inputs.use-header-only }} -DSEVEN_BIT_DI_BUILD_TESTS:BOOL=ON -DSEVEN_BIT_DI_BUILD_EXAMPLES:BOOL=ON ${{ inputs.args }}
+      shell: pwsh
+
+    - name: Configure CMake
+      if: ${{ inputs.library-type }} == "Static"
+      working-directory: ${{ inputs.build-dir }}
+      run: cmake .. -DCMAKE_BUILD_TYPE=${{ inputs.build-type }} -DSEVEN_BIT_DI_BUILD_SHARED=false -DCMAKE_TOOLCHAIN_FILE:STRING="${{ inputs.toolchain }}" ${{ inputs.args }}
+      shell: pwsh
+
+    - name: Configure CMake
+      if: ${{ inputs.library-type }} == "Shared"
+      working-directory: ${{ inputs.build-dir }}
+      run: cmake .. -DCMAKE_BUILD_TYPE=${{ inputs.build-type }} -DSEVEN_BIT_DI_BUILD_SHARED=true -DCMAKE_TOOLCHAIN_FILE:STRING="${{ inputs.toolchain }}" ${{ inputs.args }}
+      shell: pwsh
+
+    - name: Configure CMake
+      if: ${{ inputs.library-type }} == "HeaderOnly"
+      working-directory: ${{ inputs.build-dir }}
+      run: cmake .. -DCMAKE_BUILD_TYPE=${{ inputs.build-type }} -DCMAKE_TOOLCHAIN_FILE:STRING="${{ inputs.toolchain }}" -DSEVEN_BIT_DI_BUILD_TESTS_HO:BOOL=true -DSEVEN_BIT_DI_BUILD_EXAMPLES_HO:BOOL=true ${{ inputs.args }}
       shell: pwsh
 
     - name: Build

.github/workflows/DevCI.yml

@@ -17,7 +17,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        libraryType: [HeaderOnly, Static, Shared]
+        library-type: [HeaderOnly, Static, Shared]
         os: [ubuntu-22.04, macos-12, windows-2022]
 
     runs-on: ${{matrix.os}}
@@ -35,7 +35,7 @@ jobs:
         with:
           build-dir: ${{ env.BUILD_DIR }}
           build-type: ${{ env.BUILD_TYPE }}
-          library-type: ${{ matrix.libraryType }}
+          library-type: ${{ matrix.library-type }}
 
       - name: Test
         working-directory: ${{ env.BUILD_DIR }}

.github/workflows/MainCI.yml

@@ -16,7 +16,6 @@ jobs:
   test-gcc:
     strategy:
       matrix:
-        libraryType: [Static]
         version: [7, 8, 10, 11]
         os: [ubuntu-20.04]
 
@@ -48,7 +47,6 @@ jobs:
   test-clang:
     strategy:
       matrix:
-        libraryType: [Static]
         version: [6, 13, 14, 15]
         os: [ubuntu-20.04]
 

Docs/CMakeLists.txt

@@ -30,5 +30,6 @@ add_custom_target(GenerateDoc
 )
 
 include(GNUInstallDirs)
+
 install(DIRECTORY ${SPHINX_BUILD}
-        DESTINATION ${CMAKE_INSTALL_DOCDIR})
+        DESTINATION doc)

Docs/getting-started.rst

@@ -37,11 +37,11 @@ Installation
 
     .. code-block:: CMake
 
-        include_directories(/SevenBitDI/include)
+        include_directories(/SevenBitDI/Include)
 
 #. Building library as Static/Shared
     Download source code from the most recent release,
-    build the project using CMake_, set CMake cache var "LIBRARY_TYPE" to "Static" or "Shared",
+    build the project using CMake_, set CMake cache var "SEVEN_BIT_DI_BUILD_SHARED" to build Shared library,
     run install command 
 
     .. code-block:: sh

Examples/CMakeLists.txt

@@ -10,11 +10,11 @@ foreach(SOURCE ${SOURCES})
 
     if(SEVEN_BIT_DI_BUILD_EXAMPLE_HO)
         target_link_libraries(${FILE_NAME}
-            SevenBitDI_header_only
+            7BitDI_header_only
         )
     else()
         target_link_libraries(${FILE_NAME}
-            SevenBitDI
+            7BitDI
         )
     endif()
 

Source/CMakeLists.txt

@@ -1,28 +1,28 @@
 
 if(SEVEB_BIT_DI_BUILD_SHARED OR BUILD_SHARED_LIBS)
-  add_library(SevenBitDI SHARED
+  add_library(7BitDI SHARED
     Source.cpp ${SEVEB_BIT_DI_ALL_HEADERS}
   )
-  target_compile_definitions(SevenBitDI PUBLIC SEVEB_BIT_DI_BUILD_SHARED)
+  target_compile_definitions(7BitDI PUBLIC SEVEB_BIT_DI_BUILD_SHARED)
 else()
-  add_library(SevenBitDI STATIC
+  add_library(7BitDI STATIC
     Source.cpp ${SEVEB_BIT_DI_ALL_HEADERS}
   )
 endif()
 
-target_compile_definitions(SevenBitDI PUBLIC SEVEN_BIT_DI_COMPILED_LIB)
+target_compile_definitions(7BitDI PUBLIC SEVEN_BIT_DI_COMPILED_LIB)
 
-target_include_directories(SevenBitDI INTERFACE "$<BUILD_INTERFACE:${CMAKE_SOURCE_DIR}/Include>"
+target_include_directories(7BitDI INTERFACE "$<BUILD_INTERFACE:${CMAKE_SOURCE_DIR}/Include>"
   "$<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>")
 
-set_target_properties(SevenBitDI PROPERTIES VERSION ${SEVEN_BIT_DI_VERSION})
-set_target_properties(SevenBitDI PROPERTIES DEBUG_POSTFIX d)
+set_target_properties(7BitDI PROPERTIES VERSION ${SEVEN_BIT_DI_VERSION})
+set_target_properties(7BitDI PROPERTIES DEBUG_POSTFIX d)
 
-add_library(SevenBitDI_header_only INTERFACE)
+add_library(7BitDI_header_only INTERFACE)
 
-target_include_directories(SevenBitDI_header_only INTERFACE "$<BUILD_INTERFACE:${CMAKE_SOURCE_DIR}/Include>"
+target_include_directories(7BitDI_header_only INTERFACE "$<BUILD_INTERFACE:${CMAKE_SOURCE_DIR}/Include>"
   "$<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>")
 
 install(
-  TARGETS SevenBitDI SevenBitDI_header_only
-  EXPORT SevenBitDI)
+  TARGETS 7BitDI 7BitDI_header_only
+  EXPORT 7BitDI)

Tests/CMakeLists.txt

@@ -13,11 +13,11 @@ target_link_libraries(Tests PUBLIC
 
 if(SEVEN_BIT_DI_BUILD_TESTS_HO)
     target_link_libraries(Tests PUBLIC
-        SevenBitDI_header_only
+        7BitDI_header_only
     )
 else()
     target_link_libraries(Tests PUBLIC
-        SevenBitDI
+        7BitDI
     )
 endif()