Merge pull request #8 from RomualdRousseau/feature/new-doc-system

refacto: Add mkdocs
RomualdRousseau · Aug 27, 2024 · 9da48b0 · 9da48b0
2 parents 6771ba6 + 12293c2
commit 9da48b0
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 20 deletions.
diff --git a/.github/workflows/maven-deploy-doc.yml b/.github/workflows/maven-deploy-doc.yml
@@ -21,6 +21,12 @@ jobs:
                   java-version: 17
                   distribution: "temurin"
 
+            - name: Set up Python 3.11
+              uses: actions/setup-python@v5
+              with:
+                  python-version: 3.11
+            - run: pip install mkdocs
+
             - name: Cache
               uses: actions/cache@v4
               with:
@@ -39,7 +45,9 @@ jobs:
               run: mvn -U -B -DskipTests install
 
             - name: Build documentation
-              run: mvn -B -P documentation site site:stage
+              run: |
+                mkdocs build --config-file ./any2json-documents/mkdocs.yml --site-dir ./target/docs
+                mvn -B -P documentation site site:stage
 
             - name: Setup pages
               uses: actions/configure-pages@v5

diff --git a/any2json-documents/justfile b/any2json-documents/justfile
diff --git a/justfile b/justfile
@@ -16,35 +16,35 @@ all: initialize test build
 
 # Initializatize maven
 initialize:
-    mvn initialize --also-make
+    mvn initialize
 
 # Clean
 clean:
-    mvn clean --also-make
+    mvn clean
 
 # Build
 build:
-    mvn -DskipTests package --also-make
+    mvn -DskipTests package
 
 # Run the tests
 test:
-    mvn -Dtest=UnitTestSuite -Dsurefire.failIfNoSpecifiedTests=false test --also-make
+    mvn -Dtest=UnitTestSuite -Dsurefire.failIfNoSpecifiedTests=false test
 
 # Run all tests
 test-full:
-    mvn -Dtest=UnitFullTestSuite -Dsurefire.failIfNoSpecifiedTests=false test --also-make
+    mvn -Dtest=UnitFullTestSuite -Dsurefire.failIfNoSpecifiedTests=false test
 
 # Install in the local repository
 install:
-	mvn -DskipTests install --also-make
+	mvn -DskipTests install
 
 # Deploy snapshot to the maven repository
 deploy-snapshot:
-	mvn clean deploy -DskipTests -P snapshot --also-make
+	mvn clean deploy -DskipTests -P snapshot
 
 # Deploy release to the maven repository
 deploy-release:
-	mvn clean deploy -DskipTests -P release --also-make
+	mvn clean deploy -DskipTests -P release
 
 # Prepape a new version
 prepare-version *args='':
@@ -59,14 +59,22 @@ revert-version:
     mvn versions:revert
 
 # Build the documentation
-build-doc:
-    just --justfile any2json-documents/justfile build
+build-doc: copy-pdfs
+    mkdocs build --config-file ./any2json-documents/mkdocs.yml --site-dir ./target/docs
     mvn -P documentation site site:stage
 
+# Serve the documentation
+serve-doc: copy-pdfs
+    mkdocs serve --config-file ./any2json-documents/mkdocs.yml
+
 # Update all plugins and dependencies
 update-dependencies:
     mvn -DcreateChecksum=true versions:display-dependency-updates
 
 # Update all plugins and dependencies
 update-plugins:
     mvn -DcreateChecksum=true versions:display-plugin-updates
+
+@copy-pdfs:
+    cp ./any2json-documents/whitepapers/Semi-structured\ Document\ Feature\ Extraction/misc/main.pdf ./any2json-documents/docs/resources/feature-extraction.pdf
+    cp ./any2json-documents/whitepapers/Table\ Layout\ Regular\ Expression\ -\ Layex/misc/main.pdf ./any2json-documents/docs/resources/layex.pdf