Gradle task for serving docs (#3846)

Author: jurrejelle

.gitignore

@@ -8,6 +8,7 @@ out/
 output/
 bin/
 libs/
+docs/site
 
 .classpath
 */.factorypath

build.gradle

@@ -86,6 +86,7 @@ apply from: "$rootDir/dependencies.gradle"
 apply from: "$rootDir/gradle/scripts/resources.gradle"
 apply from: "$rootDir/gradle/scripts/publishing.gradle"
 apply from: "$rootDir/gradle/scripts/spotless.gradle"
+apply from: "$rootDir/gradle/scripts/docs.gradle"
 
 
 tasks.withType(JavaCompile).configureEach {

docs/README.md

@@ -26,8 +26,21 @@ Once you're happy, commit these changes and make a pull request for us to review
 If you come back to work on the docs, you can use a codespace again. You might need to `pull` to bring your codespace up to date, which you can do by pressing this button in the `Source Control` tab.
 
 ![image](https://github.com/user-attachments/assets/7d1246d2-f091-4452-bdb3-edf221902503)
+
+## Running in Gradle
+
+To run mkdocs locally, run the mkdocsServe task in gradle.  
+
+Either in the gradle sidebar, click documentation/mkdocsServe, or run .`/gradlew mkdocsServe`.  
+
+Click on the link it gives you at the bottom to open the local copy, and pages will automatically update with content as you save your files.
+
+You can also run documentation/mkdocsBuild. This will build the documentation in `docs/site`, which you can either host yourself or just open in a browser.
+
 ## Installing Required Dependencies & Run Locally
 
+If you want to manually install and go through the steps to run locally, you can follow the steps below.
+
 Please run all commands from this section inside the `docs` folder!
 
 **First, setup a venv for python:**

gradle/scripts/docs.gradle

@@ -0,0 +1,41 @@
+import org.apache.tools.ant.taskdefs.condition.Os
+
+tasks.register('mkdocsSetup', Exec) {
+    description = "Installs requirements for the MkDocs server."
+    group = "documentation"
+
+    workingDir 'docs'
+    if (Os.isFamily(Os.FAMILY_WINDOWS)) {
+        commandLine 'cmd.exe', '/c',
+                'python -m venv .venv && .venv\\Scripts\\pip.exe install -r requirements.txt'
+    } else {
+        commandLine '/usr/bin/env', 'bash', '-c',
+                'python3 -m venv .venv && ./.venv/bin/pip3 install -r requirements.txt'
+    }
+}
+
+tasks.register('mkdocsServe', Exec) {
+    description = "Runs the MkDocs server."
+    group = "documentation"
+    dependsOn tasks.named('mkdocsSetup')
+
+    workingDir 'docs'
+    if (Os.isFamily(Os.FAMILY_WINDOWS)) {
+        commandLine '.\\docs\\.venv\\Scripts\\mkdocs.exe', 'serve'
+    } else {
+        commandLine './docs/.venv/bin/mkdocs', 'serve'
+    }
+}
+
+tasks.register('mkdocsBuild', Exec) {
+    description = "Builds the MkDocs documentation in docs/site."
+    group = "documentation"
+    dependsOn tasks.named('mkdocsSetup')
+
+    workingDir 'docs'
+    if (Os.isFamily(Os.FAMILY_WINDOWS)) {
+        commandLine '.\\docs\\.venv\\Scripts\\mkdocs.exe', 'build'
+    } else {
+        commandLine './docs/.venv/bin/mkdocs', 'build'
+    }
+}