Skip to content

Commit

Permalink
add docsgen invocations to scripts (#13892)
Browse files Browse the repository at this point in the history
  • Loading branch information
morganchen12 authored Oct 14, 2024
1 parent e1d1ad9 commit ab94252
Show file tree
Hide file tree
Showing 3 changed files with 130 additions and 0 deletions.
47 changes: 47 additions & 0 deletions scripts/docsgen/jazzy_generate_mixed.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
#!/bin/bash

# Copyright 2024 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

set -ex

if [[ "$#" != 4 ]]
then
echo -e "Usage: ./jazzy_generate.sh output_dir xcworkspace_path umbrella_header_path module_name"
exit 1
fi

output_dir=$1
workspace_path=$2
umbrella_header_path=$3
module_name=$4

SWIFT_VERSION="$(xcrun swift -version | cut -d " " -f 4)"

# Generate temporary sourcekitten files.
mkdir -p "$output_dir"
sourcekitten \
doc --objc "$umbrella_header_path" \
-- -x objective-c -isysroot "$(xcrun --show-sdk-path --sdk iphonesimulator)" \
-I "$workspace_path" -fmodules > "$output_dir"/objcDoc.json
sourcekitten \
doc -- -workspace "$workspace_path" \
-scheme "$module_name" > "$output_dir"/swiftDoc.json

# Generates reference docs using jazzy
jazzy \
--author "Firebase" \
--module "$module_name" \
--output "$output_dir" \
--sourcekitten-sourcefile "$output_dir/swiftDoc.json,$output_dir/objcDoc.json"
44 changes: 44 additions & 0 deletions scripts/docsgen/jazzy_generate_objc.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
#!/bin/bash

# Copyright 2024 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

set -ex

if [[ "$#" != 4 ]]
then
echo -e "Usage: ./jazzy_generate.sh output_dir xcworkspace_path umbrella_header_path module_name"
exit 1
fi

output_dir=$1
workspace_path=$2
umbrella_header_path=$3
module_name=$4

SWIFT_VERSION="$(xcrun swift -version | cut -d " " -f 4)"

# Generate temporary sourcekitten files.
mkdir -p "$output_dir"
sourcekitten \
doc --objc "$umbrella_header_path" \
-- -x objective-c -isysroot "$(xcrun --show-sdk-path --sdk iphonesimulator)" \
-I "$workspace_path" -fmodules > "$output_dir"/objcDoc.json

# Generates reference docs using jazzy
jazzy \
--author "Firebase" \
--module "$module_name" \
--output "$output_dir" \
--sourcekitten-sourcefile "$output_dir"/objcDoc.json
39 changes: 39 additions & 0 deletions scripts/docsgen/jazzy_generate_swift.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
#!/bin/bash

# Copyright 2024 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

set -ex

if [[ "$#" != 3 ]]
then
echo -e "Usage: ./jazzy_generate.sh output_dir xcworkspace_path module_name"
exit 1
fi

output_dir=$1
workspace_path=$2
module_name=$3

SWIFT_VERSION="$(xcrun swift -version | cut -d " " -f 4)"

jazzy \
--clean \
--author "Firebase" \
--swift-version "${SWIFT_VERSION}" \
--sdk iphonesimulator \
--build-tool-arguments -workspace,"$workspace_path",-scheme,"$module_name" \
--module "$module_name" \
--output "$output_dir" \
--swift-build-tool xcodebuild

0 comments on commit ab94252

Please sign in to comment.