Merge pull request #91 from lukepistrol/fix/docc-generation

Fix/docc generation

Author: lukepistrol

.github/scripts/build-docc.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+export LC_CTYPE=en_US.UTF-8
+
+set -o pipefail && xcodebuild clean docbuild -scheme CodeEditTextView \
+    -destination generic/platform=macos \
+    OTHER_DOCC_FLAGS="--transform-for-static-hosting --hosting-base-path CodeEditTextView --output-path ./docs" | xcpretty

.github/workflows/build-documentation.yml

@@ -5,19 +5,15 @@ on:
       - 'main'
     paths:
       - 'Sources/**'
+  workflow_dispatch:
 jobs:
   build-docc:
     runs-on: macos-12
     steps:
       - name: Checkout repository
         uses: actions/checkout@v1
-      - uses: fwcd/[email protected]
-        with:
-          target: CodeEditTextView
-          output: ./docs
-          hosting-base-path: CodeEditTextView
-          disable-indexing: 'true'
-          transform-for-static-hosting: 'true'
+      - name: Build Documentation
+        run: exec ./.github/scripts/build-docc.sh
       - name: Init new repo in dist folder and commit generated files
         run: |
           cd docs
@@ -34,3 +30,29 @@ jobs:
           branch: docs
           force: true
           directory: ./docs
+
+      ############################
+      ##### IMPORTANT NOTICE #####
+      ############################
+      # This was used to build the documentation catalog until
+      # it didn't produce the 'documentation' directory anymore.
+      #
+      # - uses: fwcd/[email protected]
+      #   with:
+      #     target: CodeEditTextView
+      #     output: ./docs
+      #     hosting-base-path: CodeEditTextView
+      #     disable-indexing: 'true'
+      #     transform-for-static-hosting: 'true'
+      #
+      # The command that this plugin uses is:
+      #
+      # swift package --allow-writing-to-directory ./docs generate-documentation \
+      #       --target CodeEditTextView 
+      #       --output-path ./docs 
+      #       --hosting-base-path CodeEditTextView
+      #       --disable-indexing 
+      #       --transform-for-static-hosting
+      #
+      # We now use xcodebuild to build the documentation catalog instead.
+      #