Merge pull request #7 from lukepistrol/chore/cleanup-build-docc

add documentation comments, improve build-docc.sh script

Author: lukepistrol

.github/scripts/build-docc.sh

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

.github/workflows/build-documentation.yml

@@ -15,13 +15,6 @@ jobs:
         uses: actions/checkout@v1
       - name: Build Documentation
         run: exec ./.github/scripts/build-docc.sh
-      # - uses: fwcd/[email protected]
-      #   with:
-      #     target: CodeEditLanguages
-      #     output: ./docs
-      #     hosting-base-path: CodeEditLanguages
-      #     disable-indexing: 'true'
-      #     transform-for-static-hosting: 'true'
       - name: Init new repo in dist folder and commit generated files
         run: |
           cd docs
@@ -37,4 +30,30 @@ jobs:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           branch: docs
           force: true
-          directory: ./docs
+          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: CodeEditLanguages
+      #     output: ./docs
+      #     hosting-base-path: CodeEditLanguages
+      #     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 CodeEditLanguages 
+      #       --output-path ./docs 
+      #       --hosting-base-path CodeEditLanguages 
+      #       --disable-indexing 
+      #       --transform-for-static-hosting
+      #
+      # We now use xcodebuild to build the documentation catalog instead.
+      #