Skip to content

Fix DocC resource URLs on GitHub Pages #21

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
SoundBlaster merged 2 commits into from
Nov 11, 2025
Merged

Fix DocC resource URLs on GitHub Pages #21

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a01b4ad
Fix DocC resource URLs on GitHub Pages
claude Nov 11, 2025
17a8a94
Improve DocC workflow maintainability and robustness
claude Nov 11, 2025
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
17 changes: 14 additions & 3 deletions .github/workflows/docc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ concurrency:
group: docc-pages
cancel-in-progress: true

env:
DOCC_HOSTING_BASE_PATH: NavigationSplitView

jobs:
build:
name: Build DocC archive
Expand All @@ -24,15 +27,19 @@ jobs:
- name: Checkout code
uses: actions/checkout@v4

- name: Select Xcode 16.1 Developer Directory
run: sudo xcode-select -s /Applications/Xcode_16.1.app/Contents/Developer
- name: Select Xcode 16.1
uses: maxim-lobanov/setup-xcode@v1
with:
xcode-version: "16.1"

- name: Show Xcode version
run: xcodebuild -version

- name: Build documentation archive
run: |
set -eo pipefail
# Clean up any previous build artifacts
rm -rf DocsArchive DocsBuild
mkdir -p DocsArchive
xcrun docc convert XcodeProject/NewNav/Documentation.docc \
--fallback-display-name "NavigationSplitView" \
Expand All @@ -45,9 +52,13 @@ jobs:
run: |
set -eo pipefail
xcrun docc process-archive transform-for-static-hosting DocsArchive/NavigationSplitView.doccarchive \
--hosting-base-path /NavigationSplitView \
--hosting-base-path "$DOCC_HOSTING_BASE_PATH" \
--output-path DocsBuild

# Fix the baseURL in generated HTML
# DocC's --hosting-base-path doesn't always set baseURL correctly, so we fix it manually
sed -i '' "s|\"baseURL\": \"/\"|\"baseURL\": \"/$DOCC_HOSTING_BASE_PATH/\"|g" DocsBuild/index.html

- name: Upload documentation artifact
if: github.event_name == 'push'
uses: actions/upload-pages-artifact@v3
Expand Down