Skip to content

chore(docs): Add Makefile target to build Jazzy docs #425

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
philprime merged 1 commit into from
Dec 29, 2025
Merged

chore(docs): Add Makefile target to build Jazzy docs #425

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 1 addition & 5 deletions .github/workflows/documentation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,7 @@ jobs:
sed -i.bak "s/title:\(.*\)/title:\1 ($ESCAPED_REF_NAME)/g" .jazzy.yaml

- name: Generate Documentation with Jazzy
run: |
SDK_PATH=`xcrun --sdk iphonesimulator --show-sdk-path`
SDK_VERSION=`xcrun --sdk iphonesimulator --show-sdk-version`
bundle exec jazzy \
--build-tool-arguments "--sdk,${SDK_PATH},-Xswiftc,-sdk,-Xswiftc,$SDK_PATH,-Xswiftc,-target,-Xswiftc,arm64-apple-ios${SDK_VERSION}-simulator"
run: make docs

- name: Fix Invalid URLs
run: |
Expand Down
17 changes: 16 additions & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,7 +312,22 @@ lint:
dprint check "**/*.{md,json,yaml,yml}"

# ============================================================================
# HELP & DOCUMENTATION
# DOCUMENTATION
# ============================================================================

## Generate documentation using Jazzy
#
# Generates documentation for the TPPDF project using Jazzy.
.PHONY: docs
docs:
SDK_PATH=$$(xcrun --sdk iphonesimulator --show-sdk-path); \
echo "SDK Path: $$SDK_PATH"; \
SDK_VERSION=$$(xcrun --sdk iphonesimulator --show-sdk-version); \
echo "SDK Version: $$SDK_VERSION"; \
bundle exec jazzy --build-tool-arguments "--sdk,$$SDK_PATH,-Xswiftc,-sdk,-Xswiftc,$$SDK_PATH,-Xswiftc,-target,-Xswiftc,arm64-apple-ios$$SDK_VERSION-simulator"

# ============================================================================
# HELP
# ============================================================================

# Reusable awk script for detailed help output
Expand Down
Loading