Skip to content

Commit 538b9a3

Browse files
authored
Switch docs from jazzy to DocC (#399)
* WIP on migrating to docc * Fix up links and theme-settings.json * GHA doesn't seem to have Xcode 15 anymore * Update GHA docs actions * fix: Update GitHub Actions workflows for DocC migration - Add CI environment detection to docs.sh script - Use mkdocs directly in GitHub Actions instead of mkdocs-dev.sh - Maintain backward compatibility for local development workflow This resolves the CI failure where mkdocs-dev.sh expected a virtual environment that doesn't exist in GitHub Actions runners, since dependencies are installed globally in CI. * macOS 26 is not yet on GitHub * Unversion migration doc * WIP on document, reviewing TripKitAPI * Simplify project * Fix up including additional docc content in docs * Make couple of parameters of `TKRouter.fetchTripsResponse` optional; update docs
1 parent 3baeeca commit 538b9a3

File tree

29 files changed

+1109
-2915
lines changed

29 files changed

+1109
-2915
lines changed

.github/workflows/docs-dryrun.yml

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: Build docs
22

33
on:
44
pull_request:
5-
branches: [ main ]
5+
branches: [main]
66
# Allows you to run this workflow manually from the Actions tab
77
workflow_dispatch:
88

@@ -21,14 +21,12 @@ jobs:
2121
python-version: 3.x
2222
- name: Prepare dependencies
2323
run: |
24-
brew install sourcekitten
2524
python --version
2625
pip install --upgrade pip
2726
pip install mkdocs
2827
pip install pymdown-extensions
2928
pip install git+https://github.com/skedgo/skedgo-mkdocs-theme
30-
mkdocs --version
31-
bundle install
29+
mkdocs --version
3230
3331
- name: Build docs
3432
run: |

.github/workflows/docs.yml

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: Deploy docs
22

33
on:
44
push:
5-
branches: [ main ]
5+
branches: [main]
66
# Allows you to run this workflow manually from the Actions tab
77
workflow_dispatch:
88

@@ -21,14 +21,12 @@ jobs:
2121
python-version: 3.x
2222
- name: Prepare dependencies
2323
run: |
24-
brew install sourcekitten
2524
python --version
2625
pip install --upgrade pip
2726
pip install mkdocs
28-
pip install pymdown-extensions
27+
pip install pymdown-extensions
2928
pip install git+https://github.com/skedgo/skedgo-mkdocs-theme
30-
mkdocs --version
31-
bundle install
29+
mkdocs --version
3230
3331
- name: Build docs
3432
run: |

.github/workflows/swift.yml

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,31 @@ on:
44
push:
55
branches: [main]
66
paths:
7-
- 'Sources/**'
8-
- 'Tests/**'
9-
- 'Package.swift'
10-
- 'TripKit.xcodeproj/**'
11-
- 'Examples/**'
7+
- "Sources/**"
8+
- "Tests/**"
9+
- "Package.swift"
10+
- "TripKit.xcodeproj/**"
11+
- "Examples/**"
1212
pull_request:
1313
paths:
14-
- 'Sources/**'
15-
- 'Tests/**'
16-
- 'Package.swift'
17-
- 'TripKit.xcodeproj/**'
18-
- 'Examples/**'
14+
- "Sources/**"
15+
- "Tests/**"
16+
- "Package.swift"
17+
- "TripKit.xcodeproj/**"
18+
- "Examples/**"
1919
workflow_dispatch:
2020

2121
jobs:
2222
build_spm:
2323
strategy:
2424
matrix:
2525
include:
26+
# - os: macos-26
27+
# xcode: "26.0"
2628
- os: macos-15
27-
xcode: '16.2'
28-
- os: macos-15
29-
xcode: '15.4'
30-
- os: macos-14
31-
xcode: '16.1' # sic, 16.2 not available on GitHub as of Jan 2025
29+
xcode: "16.4"
3230
- os: macos-14
33-
xcode: '15.4'
31+
xcode: "16.1" # sic, 16.2 not available on GitHub as of Jan 2025
3432

3533
runs-on: ${{ matrix.os }}
3634

@@ -49,13 +47,13 @@ jobs:
4947
matrix:
5048
swift: ["6.0", "5.10"]
5149
container:
52-
image: swift:${{ matrix.swift }}
50+
image: swift:${{ matrix.swift }}
5351

5452
steps:
5553
- uses: actions/checkout@v4
5654
- name: Build
57-
run: swift build --target TripKitAPI
58-
55+
run: swift build --target TripKitAPI
56+
5957
build_xcode:
6058
runs-on: macos-15
6159

.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,5 +34,8 @@ TripKit.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved
3434
/Scripts/docs/source/TripKit
3535
/Scripts/docs/source/TripKitUI
3636
/Scripts/docs/source/TripKitInterApp
37+
/Scripts/docs/source/sdk
3738
/Scripts/docs/site
38-
/public
39+
/docc_archives/
40+
41+
/public

.jazzy.yaml

Lines changed: 0 additions & 99 deletions
This file was deleted.

Gemfile

Lines changed: 0 additions & 4 deletions
This file was deleted.

Gemfile.lock

Lines changed: 0 additions & 135 deletions
This file was deleted.

0 commit comments

Comments
 (0)