Merge pull request #69 from bact/add-javadoc-website

Generate Javadoc website

Author: goneall

.github/workflows/docs.yml

@@ -0,0 +1,36 @@
+# SPDX-FileCopyrightText: 2025 SPDX contributors
+# SPDX-FileType: SOURCE
+# SPDX-License-Identifier: Apache-2.0
+
+name: Generate and publish API JavaDocs
+on:
+  push:
+    branches: [ master ]
+  workflow_dispatch:
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+    - uses: actions/setup-java@v4
+      with:
+        distribution: 'temurin'
+        java-version: 21
+    - name: Cache Maven packages
+      uses: actions/cache@v4
+      with:
+        path: ~/.m2
+        key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
+
+    - name: Generate docs
+      run: mvn javadoc:javadoc
+
+    - name: Deploy docs
+      uses: peaceiris/actions-gh-pages@v4
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./target/reports/apidocs

README.md

@@ -2,6 +2,8 @@
 
 This Java library implements an RDF store supported [SPDX spec version 2.3][spdx2.3] and earlier implementing the [SPDX Java Library Storage Interface][storage] using an underlying RDF store.
 
+The API documentation is available at:
+<https://spdx.github.io/spdx-java-rdf-store/>
 [spdx2.3]: https://spdx.github.io/spdx-spec/v2.3/
 [storage]: https://github.com/spdx/Spdx-Java-Library#storage-interface