generate.sh

#!/bin/bash

# Sources:
#   - https://github.com/apple/swift-docc-plugin
#   - https://apple.github.io/swift-docc-plugin/documentation/swiftdoccplugin/
#   - https://apple.github.io/swift-docc-plugin/documentation/swiftdoccplugin/generating-documentation-for-hosting-online
#   - https://www.swift.org/documentation/docc/
#   - https://www.swift.org/documentation/docc/distributing-documentation-to-other-developers

# Define the output directory.
output_directory=${1-'output'}

# Create the output directory.
mkdir $output_directory

# Define a function for generating a .doccarchive.
generate_archive() {
    product=$1

    echo "Generating archive for ${product} in ${output_directory}..."

    swift package --allow-writing-to-directory $output_directory \
        generate-documentation \
        --product $product \
        --hosting-base-path $product \
        --output-path "${output_directory}/${product}.doccarchive"

    # TODO: To save space, we can make this file zip the archives instead. For example:
    # zip -r "${output_directory}/docs.zip" "${output_directory}/${product}.doccarchive"

    # TODO: Once we can confirm the above is working, try enabling the following flags:
    # --disable-indexing # apparently only necessary for IDE documentation navigation
}

# Add new entries for every product here.
# Note that this will only work with PRODUCTS within your dependency graph,
# if you need to work with targets, you'll have to update this script.
generate_archive AudioKit
generate_archive AudioKitEX
generate_archive AudioKitUI

generate_archive DevoloopAudioKit
generate_archive DunneAudioKit
generate_archive Flow
generate_archive Keyboard

generate_archive Microtonality
generate_archive PianoRoll
generate_archive SoundpipeAudioKit

generate_archive SporthAudioKit
generate_archive STKAudioKit
generate_archive Tonic