From 71699b3a0c181f68fa79000f6bdbb35e70f07f83 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ivan=20=E2=80=9CCLOVIS=E2=80=9D=20Canet?=
 <ivan.canet@gmail.com>
Date: Sat, 21 Dec 2024 15:13:59 +0100
Subject: [PATCH] docs(website): Embed the Dokka output into the docs website

---
 .idea/runConfigurations/Documentation.xml                | 1 +
 docs/website/.gitignore                                  | 3 +++
 docs/website/.gitlab-ci.yml                              | 3 +++
 docs/website/build.gradle.kts                            | 9 +++++++++
 docs/website/mkdocs.yml                                  | 5 ++++-
 .../template-lib/src/commonMain/kotlin/HelloWorld.kt     | 3 +++
 settings.gradle.kts                                      | 1 +
 7 files changed, 24 insertions(+), 1 deletion(-)
 create mode 100644 docs/website/build.gradle.kts

diff --git a/.idea/runConfigurations/Documentation.xml b/.idea/runConfigurations/Documentation.xml
index e31ca5b..c2c66d2 100644
--- a/.idea/runConfigurations/Documentation.xml
+++ b/.idea/runConfigurations/Documentation.xml
@@ -11,6 +11,7 @@
       <option name="taskNames">
         <list>
           <option value=":dokkaGeneratePublicationHtml" />
+          <option value=":docs:website:embedDokkaIntoMkDocs" />
         </list>
       </option>
       <option name="vmOptions" />
diff --git a/docs/website/.gitignore b/docs/website/.gitignore
index 16d3c4d..329639a 100644
--- a/docs/website/.gitignore
+++ b/docs/website/.gitignore
@@ -1 +1,4 @@
 .cache
+
+# Dokka output
+api/
diff --git a/docs/website/.gitlab-ci.yml b/docs/website/.gitlab-ci.yml
index 4cf2735..da39ede 100644
--- a/docs/website/.gitlab-ci.yml
+++ b/docs/website/.gitlab-ci.yml
@@ -2,8 +2,11 @@
 mkdocs:
   image: registry.gitlab.com/opensavvy/automation/containers/mkdocs:$ci_containers
   stage: build
+  extends: [ .os.gradle ]
+  needs: [ os.version ]
 
   before_script:
+    - ./gradlew docs:website:embedDokkaIntoMkDocs -PappVersion=$project_version
     - cd docs/website
     - ls
     - 'echo "repo_url: $CI_PROJECT_URL">>mkdocs.yml'
diff --git a/docs/website/build.gradle.kts b/docs/website/build.gradle.kts
new file mode 100644
index 0000000..2546603
--- /dev/null
+++ b/docs/website/build.gradle.kts
@@ -0,0 +1,9 @@
+plugins {
+	alias(opensavvyConventions.plugins.base)
+	id("dev.opensavvy.dokka-mkdocs")
+}
+
+dependencies {
+	// List the 'library' projects
+	// dokka(projects.core)
+}
diff --git a/docs/website/mkdocs.yml b/docs/website/mkdocs.yml
index 9ead25d..937da81 100644
--- a/docs/website/mkdocs.yml
+++ b/docs/website/mkdocs.yml
@@ -91,5 +91,8 @@ nav:
 
   - Module2: []
 
-  - Reference:
+# !!! EMBEDDED DOKKA START, DO NOT COMMIT !!! #
+# !!! EMBEDDED DOKKA END, DO NOT COMMIT !!! #
+
+  - Reference (external):
       - reference.md
diff --git a/gradle/templates/template-lib/src/commonMain/kotlin/HelloWorld.kt b/gradle/templates/template-lib/src/commonMain/kotlin/HelloWorld.kt
index b87d0d9..fb7defd 100644
--- a/gradle/templates/template-lib/src/commonMain/kotlin/HelloWorld.kt
+++ b/gradle/templates/template-lib/src/commonMain/kotlin/HelloWorld.kt
@@ -1,3 +1,6 @@
 package opensavvy.playground.core
 
+/**
+ * A hello world message.
+ */
 const val message = "Hello World!"
diff --git a/settings.gradle.kts b/settings.gradle.kts
index ee219fe..be40203 100644
--- a/settings.gradle.kts
+++ b/settings.gradle.kts
@@ -53,6 +53,7 @@ plugins {
 }
 
 include(
+	"docs:website",
 	"gradle:templates:template-app",
 	"gradle:templates:template-lib",
 )
-- 
2.51.2