build: integrate docs into flake and ci

Signed-off-by: Felix Hilgers <[email protected]>
amosproj · Nov 13, 2024 · e2306ab · e2306ab
1 parent e8f0caa
commit e2306ab
Show file tree

Hide file tree

Showing 11 changed files with 23 additions and 780 deletions.
diff --git a/.github/workflows/lint_build_test.yml b/.github/workflows/lint_build_test.yml
@@ -23,6 +23,19 @@ jobs:
 
       - name: Lint
         run: nix run .#reuseLint
+
+  documentation:
+    name: Build Documentation
+    runs-on: ubuntu-24.04
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/setup-base
+
+      - name: Asciidoctor
+        run: |
+          nix develop --command \
+            asciidoctor -r asciidoctor-diagram Documentation/asciidoc/main.adoc -o index.html
         
   gradle-lint:
     name: Gradle Lint
@@ -75,4 +88,4 @@ jobs:
       - uses: ./.github/actions/setup-rust-cache
 
       - name: Build and Test
-        run: nix run .#rustTest
+        run: nix run .#rustTest
diff --git a/Documentation/README.md b/Documentation/README.md
@@ -6,16 +6,12 @@ SPDX-License-Identifier: MIT
 
 # Android - Zero Code Instrumentation Observability
 
-Build, user, and technical documentation Software architecture description
+Build, user, and technical documentation Software architecture description.
 
 ## Build documentation
 
-Output is written to the `./doc/build` folder. All commands are executed from the project root.
+To generate the html documentation run the following:
 
-### HTML
-
-```bash
-# ./gradlew asciidoctor
 ```
-
-The final document `main.html` can be found in `./doc/build/doc`
+asciidoctor -r asciidoctor-diagram asciidoctor/main.adoc -o build/doc/index.html
+```
diff --git a/Documentation/asciidoc/images/header.svg b/Documentation/asciidoc/images/header.svg
diff --git a/Documentation/asciidoc/images/header.svg b/Documentation/asciidoc/images/header.svg
@@ -0,0 +1 @@
+../../../Deliverables/sprint-01/team-logo.svg
diff --git a/Documentation/build.gradle b/Documentation/build.gradle
diff --git a/Documentation/gradle/wrapper/gradle-wrapper.jar b/Documentation/gradle/wrapper/gradle-wrapper.jar
diff --git a/Documentation/gradle/wrapper/gradle-wrapper.properties b/Documentation/gradle/wrapper/gradle-wrapper.properties
diff --git a/Documentation/gradlew b/Documentation/gradlew
diff --git a/Documentation/gradlew.bat b/Documentation/gradlew.bat
diff --git a/Documentation/settings.gradle.kts b/Documentation/settings.gradle.kts
diff --git a/REUSE.toml b/REUSE.toml
@@ -23,6 +23,7 @@ SPDX-FileCopyrightText = "2015 the original author or authors"
 [[annotations]]
 path = [
     "Deliverables/**",
+    "Documentation/**",
 ]
 SPDX-License-Identifier = "CC-BY-4.0"
 SPDX-FileCopyrightText = "2024 The AMOS Projects"
@@ -35,4 +36,4 @@ path = [
     "rust/Cargo.lock",
 ]
 SPDX-FileCopyrightText = "NONE"
-SPDX-License-Identifier = "CC0-1.0"
+SPDX-License-Identifier = "CC0-1.0"