chore: Configure Dokka and Release Action to Include Customised Styles (#113)

Author: Mohammad-Dwairi

.github/workflows/generate-docs-site.yml

@@ -39,14 +39,14 @@ jobs:
           mkdir older/${{ env.LATEST_DOCS_VERSION }} 
           mv images rapid-sdk scripts styles index.html navigation.html not-found-version.html version.json older/${{ env.LATEST_DOCS_VERSION }}
 
-      - name: Move the "older" Directory to a Temporary Workspace
-        run: mv older ${{ runner.temp }}
+      - name: Move the "older" and "assets" Directories to a Temporary Workspace
+        run: mv older assets ${{ runner.temp }}
 
       - name: Checkout "main" Branch
         run: git checkout main
 
       - name: Generate New Release Reference Docs
-        run: mvn -f code dokka:dokka -Ddokka-old-versions.location=${{ runner.temp }}/older
+        run: mvn -f code dokka:dokka -Ddokka-old-versions.location=${{ runner.temp }}/older -Ddokka-assets.location=${{ runner.temp }}/assets
 
       - name: Extract and Store Newly Generated Docs Version Number
         run: echo "NEW_DOCS_VERSION=$(jq -r '.version' code/target/dokka/version.json)" >> $GITHUB_ENV

code/pom.xml

@@ -74,6 +74,7 @@
         <jacoco-plugin.version>0.8.12</jacoco-plugin.version>
         <dokka-plugin.version>1.9.20</dokka-plugin.version>
         <dokka-old-versions.location/> <!-- passed as a property when running dokka:dokka-->
+        <dokka-assets.location/> <!-- passed as a property when running dokka:dokka-->
         <properties.maven.plugin.version>1.2.1</properties.maven.plugin.version>
         <maven.licence.plugin.version>4.5</maven.licence.plugin.version>
         <flatten.maven.plugin.version>1.6.0</flatten.maven.plugin.version>
@@ -568,6 +569,7 @@
                 <groupId>org.jetbrains.dokka</groupId>
                 <artifactId>dokka-maven-plugin</artifactId>
                 <configuration>
+                    <moduleName>Rapid Java SDK</moduleName>
                     <sourceDirectories>
                         <dir>${project.basedir}/src/main/kotlin/com/expediagroup/sdk/rapid</dir>
                         <dir>${project.basedir}/src/main/kotlin/com/expediagroup/sdk/domain/rapid</dir>
@@ -589,6 +591,14 @@
                             <version>${project.version}</version>
                             <olderVersionsDir>${dokka-old-versions.location}</olderVersionsDir>
                         </org.jetbrains.dokka.versioning.VersioningPlugin>
+                        <org.jetbrains.dokka.base.DokkaBase>
+                            <customAssets>
+                                <asset>${dokka-assets.location}/logo-icon.svg</asset>
+                            </customAssets>
+                            <customStyleSheets>
+                                <stylesheet>${dokka-assets.location}/custom-styles.css</stylesheet>
+                            </customStyleSheets>
+                        </org.jetbrains.dokka.base.DokkaBase>
                     </pluginsConfiguration>
                     <suppressInheritedMembers>true</suppressInheritedMembers>
                 </configuration>
@@ -792,6 +802,7 @@
                         <groupId>org.jetbrains.dokka</groupId>
                         <artifactId>dokka-maven-plugin</artifactId>
                         <configuration>
+                            <moduleName>Rapid Java SDK</moduleName>
                             <sourceDirectories>
                                 <dir>${project.basedir}/src/main/kotlin/com/expediagroup/sdk/rapid</dir>
                             </sourceDirectories>
@@ -812,6 +823,14 @@
                                     <version>${project.version}</version>
                                     <olderVersionsDir>${dokka-old-versions.location}</olderVersionsDir>
                                 </org.jetbrains.dokka.versioning.VersioningPlugin>
+                                <org.jetbrains.dokka.base.DokkaBase>
+                                    <customAssets>
+                                        <asset>${dokka-assets.location}/logo-icon.svg</asset>
+                                    </customAssets>
+                                    <customStyleSheets>
+                                        <stylesheet>${dokka-assets.location}/custom-styles.css</stylesheet>
+                                    </customStyleSheets>
+                                </org.jetbrains.dokka.base.DokkaBase>
                             </pluginsConfiguration>
                         </configuration>
                         <executions>