Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
7226cfd
initial script and data to build the combined collection of docs indi…
heckj Mar 11, 2026
4f49606
updates to combine, use header/footer
heckj Mar 11, 2026
f5b6b67
fix for special case of diagnostics directory
heckj Mar 11, 2026
d704b4b
script updates for embedded and cleaner names
heckj Mar 11, 2026
85e7c39
ignore the header and footer inclusions from the build process
heckj Mar 11, 2026
560aa03
adding spaces into names for targets
heckj Mar 11, 2026
02332f8
nicer collection names
heckj Mar 12, 2026
9e217c8
missed one
heckj Mar 12, 2026
e633f1e
adding WASM docc collection that's hosted at https://docs.swift.org/w…
heckj Mar 12, 2026
bdaa283
naming trials, ordering check
heckj Mar 12, 2026
de6c689
noting ordering impact in script
heckj Mar 12, 2026
f96f884
naming tweaks and resetting package names back to make it easier to r…
heckj Mar 12, 2026
f8139fe
branching support, injecting docc-plugin
heckj Mar 12, 2026
3e37a71
moving docc after swiftpm and testing
heckj Mar 12, 2026
b67fd66
using Copyright from TSPL book for the common footer
heckj Mar 12, 2026
978a2b1
efficiency check and better use of docc as an array instead of two it…
heckj Mar 26, 2026
c76383d
building them all combined, exporting a manifest of what branches wer…
heckj Mar 26, 2026
2da9947
enabling specific prep work per repo (needed for swift-book)
heckj Mar 26, 2026
4c2af6f
Add license headers and .licenseignore to pass CI checks
heckj Apr 3, 2026
bd8e760
Add license headers to HTML files and trim .licenseignore
heckj Apr 3, 2026
2e8aaf2
Rewrite build script as Python 3 with pinned source refs
heckj Apr 3, 2026
93e6765
Add GitHub Actions workflow for combined documentation build
heckj Apr 3, 2026
b349a78
Install python3 in CI container before running build script
heckj Apr 5, 2026
02fd875
Switch CI container to nightly-main-noble for swift-testing compat
heckj Apr 5, 2026
e1a399b
Try swift:6.2-jammy container to match shared CI defaults
heckj Apr 5, 2026
6926f2d
Switch to nightly-main-jammy for swift-testing 6.3 tools compat
heckj Apr 5, 2026
439e561
Fix artifact upload path with explicit output directory
heckj Apr 5, 2026
020ef28
Add git clean after reset to remove stale untracked files
heckj Apr 5, 2026
9dc557a
Tar build output before upload to avoid NTFS filename restrictions
heckj Apr 5, 2026
0ccde02
renaming final docc archive as just a directory, stripping extension …
heckj Apr 6, 2026
03fda01
update to v6 checkout
heckj Apr 6, 2026
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
41 changes: 41 additions & 0 deletions .github/workflows/build_documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Build documentation

on:
pull_request:
types: [opened, reopened, synchronize]
push:
branches: [main]

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

jobs:
build-docs:
name: Build combined documentation
runs-on: ubuntu-latest
container:
image: swiftlang/swift:nightly-main-jammy
steps:
- uses: actions/checkout@v6

- uses: actions/cache@v4
with:
path: .workspace
key: docs-workspace-${{ hashFiles('scripts/sources.json') }}
restore-keys: |
docs-workspace-

- name: Install Python
run: apt-get update && apt-get install -y python3

- name: Build documentation
run: python3 scripts/build_docs.py --output-dir "$GITHUB_WORKSPACE/build-output"

- name: Package build output
run: tar -czf "$GITHUB_WORKSPACE/combined-documentation.tar.gz" -C "$GITHUB_WORKSPACE/build-output" .

- uses: actions/upload-artifact@v4
with:
name: combined-documentation
path: combined-documentation.tar.gz
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,8 @@
.build
.swiftpm
Package.resolved
.build-workspace/
.workspace/
.build-output/
**/*.docc/header.html
**/*.docc/footer.html
4 changes: 4 additions & 0 deletions api-guidelines/Sources/APIGuidelines.docc/Documentation.md
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
# ``APIGuidelines``

@Metadata {
@DisplayName("API Guidelines")
}
11 changes: 10 additions & 1 deletion common/footer.html
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
<!--
This source file is part of the Swift.org open source project

Copyright (c) 2026 Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception

See https://swift.org/LICENSE.txt for license information
See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
-->
<style>
@media all{
ul,li,h3,p,form,input,legend{margin:0;padding:0;}
Expand Down Expand Up @@ -182,7 +191,7 @@ <h3>Governance</h3>
<div class="copyright">

<p>
Copyright © 2025 Apple Inc. All rights reserved.
Copyright © 2014–2026 Apple Inc. and the Swift project authors. All rights reserved.
</p>
<p>
Swift and the Swift logo are trademarks of Apple Inc.
Expand Down
9 changes: 9 additions & 0 deletions common/header.html
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
<!--
This source file is part of the Swift.org open source project

Copyright (c) 2026 Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception

See https://swift.org/LICENSE.txt for license information
See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
-->
<style>
@media all{
ul,li,h1{margin:0;padding:0;}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
# ``EcosystemTools``

@Metadata {
@DisplayName("Tools and Editors")
}
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
# ``LanguageGuides``

@Metadata {
@DisplayName("Language Guides")
}
Loading
Loading