Add a build script for publication and use a plain DocC bundle #94
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Avoid clobbering a header file if there's one already there, and avoid leaving it around after the build completes. Also fix the path for the staging/preview version as in 2f2bbc2.
Co-authored-by: Kyle Murray <kyle_murray@apple.com>
This directory is created by the bin/publish-book script.
|
We'll need to change the swift-ci config after this change: swift package plugin generate-documentation --target TSPL --transform-for-static-hosting…to: docc convert --experimental-enable-custom-templates --hosting-base-path swift-book --output-path "./swift-book" TSPL.docc |
amartini51
approved these changes
Feb 1, 2023
bjlanier
approved these changes
Feb 1, 2023
amartini51
added a commit
to amartini51/swift-book
that referenced
this pull request
May 8, 2024
This got overlooked in PR swiftlang#94 (commit 16750eb). References: 16750eb
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds a separate script that generates a version of the book suitable for publishing on swift.org (with the non-staging header).
This conditionalizes which
header.htmlis used.This PR also moves away from using the package plugin to generate the book and instead uses plain DocC commands. This simplifies the file structure of the repo.