docbuild.bash

#!/bin/bash

echo "Make sure you've rebased over the current HEAD branch:"
echo "git rebase -i origin/main docs"

set -e  # exit on a non-zero return code from a command
set -x  # print a trace of commands as they execute

# rm -rf .build
# mkdir -p .build/symbol-graphs

# $(xcrun --find swift) build --target RSTree \
#     -Xswiftc -emit-symbol-graph \
#     -Xswiftc -emit-symbol-graph-dir -Xswiftc .build/symbol-graphs

# Enables deterministic output
# - useful when you're committing the results to host on github pages
export DOCC_JSON_PRETTYPRINT=YES

#$(xcrun --find docc) convert Sources/RSTree/Documentation.docc \
#    --output-path ./docs \
#    --fallback-display-name RSTree \
#    --fallback-bundle-identifier com.github.heckj.RSTree \
#    --fallback-bundle-version 0.1.0 \
#    --additional-symbol-graph-dir .build/symbol-graphs \
#    --emit-digest \
#    --transform-for-static-hosting \
#    --hosting-base-path 'RSTree'

# Add the following as a dependency into your Package.swift
#
# // Swift-DocC Plugin - swift 5.6 ONLY (GitHhub Actions on 1/29/2022 only supports to 5.5)
#     dependencies: [
#        .package(url: "https://github.com/apple/swift-docc-plugin", branch: "main"),
#    ],
# run:
#   $(xcrun --find swift) package resolve
#   $(xcrun --find swift) build


# Swift package plugin for hosted content:
#
$(xcrun --find swift) package \
    --allow-writing-to-directory ./docs \
    generate-documentation \
    --target RSTree \
    --output-path ./docs \
    --emit-digest \
    --disable-indexing \
    --transform-for-static-hosting \
    --hosting-base-path 'RSTree'

# Generate a list of all the identifiers to assist in DocC curation
#

# cat docs/linkable-entities.json | jq '.[].referenceURL' -r > all_identifiers.txt
# sort all_identifiers.txt \
#     | sed -e 's/doc:\/\/RSTree\/documentation\///g' \
#     | sed -e 's/^/- ``/g' \
#     | sed -e 's/$/``/g' > all_symbols.txt

echo "Page will be available at https://heckj.github.io/RSTree/documentation/rstree/"

# xcodebuild docbuild -scheme RSTree -destination platform=macOS
#
# generated RSTree.doccarchive located in ~/Library/Developer/DerivedData/RSTree*/Build/Products/Debug

# Example from swift forum post to show building docs for an iOS Xcode project:
# xcodebuild docbuild -scheme ExampleDocC \
#     -destination generic/platform=iOS \
#     OTHER_DOCC_FLAGS="--transform-for-static-hosting --hosting-base-path ExampleDocC --output-path docs"