Build docs + javadoc into one folder

exercism · Jan 23, 2024 · aa5024a · aa5024a
1 parent 4cc529d
commit aa5024a
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 7 deletions.
diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml
@@ -18,12 +18,16 @@ jobs:
         with:
           java-version: "21"
           distribution: "temurin"
-      - name: Build Javadoc
-        run: ./gradlew --no-daemon javadoc
+      - name: Set up Python
+        uses: actions/setup-python@0a5c61591373683505ea898e09a3ea4f39ef2b9c
+        with:
+          python-version: "3.12"
+      - name: Build documentation
+        run: ./gradlew --no-daemon clean mkdocsBuild javadoc
       - name: Upload artifact
         uses: actions/upload-pages-artifact@0252fc4ba7626f0298f0cf00902a25c6afc77fa8
         with:
-          path: build/docs/javadoc
+          path: build/docs
 
   deploy:
     name: Deploy to GitHub Pages

diff --git a/build.gradle b/build.gradle
@@ -46,7 +46,12 @@ python {
 }
 
 mkdocs {
-    sourcesDir = "."
-    buildDir = "build/docs/mkdocs"
+    sourcesDir = "src/doc"
+    buildDir = file("build/docs")
     publish.docPath = null
 }
+
+javadoc {
+    mustRunAfter(mkdocsBuild)
+    destinationDir = file("build/docs/api")
+}
diff --git a/docs/contributing.md b/docs/contributing.md
diff --git a/src/doc/docs/contributing.md b/src/doc/docs/contributing.md
@@ -0,0 +1 @@
+../../../CONTRIBUTING.md
diff --git a/docs/index.md → src/doc/docs/index.md b/docs/index.md → src/doc/docs/index.md
diff --git a/mkdocs.yml → src/doc/mkdocs.yml b/mkdocs.yml → src/doc/mkdocs.yml
@@ -5,7 +5,7 @@ site_url: https://exercism.github.io/java-analyzer
 
 repo_name: java-analyzer
 repo_url: https://github.com/exercism/java-analyzer
-edit_uri: blob/main/docs/
+edit_uri: blob/main/docs/src/
 
 copyright: 'Copyright &copy; 2024 Exercism'
 
@@ -40,3 +40,4 @@ markdown_extensions:
 nav:
   - Home: index.md
   - contributing.md
+  - API: /java-analyzer/api