-
Notifications
You must be signed in to change notification settings - Fork 37
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
596e173
commit e408b16
Showing
1 changed file
with
21 additions
and
1 deletion.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,14 +3,34 @@ name: Documentation | |
on: | ||
push: | ||
branches: | ||
- main | ||
- add-swift-docc # release/4_0 | ||
# ^ for now, we only want to use the v4.0 release branch. | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- uses: actions/checkout@v3 | ||
|
||
- name: Build Docs | ||
run: | | ||
mkdir -p ./gh-pages | ||
swift package --allow-writing-to-directory ./gh-pages/docs \ | ||
generate-documentation --include-extended-types \ | ||
--disable-indexing \ | ||
--output-path ./gh-pages/docs \ | ||
--transform-for-static-hosting \ | ||
--hosting-base-path OpenAPIKit \ | ||
--target OpenAPIKit | ||
- name: Deploy to GitHub Pages | ||
uses: JamesIves/[email protected] | ||
with: | ||
folder: gh-pages | ||
branch: gh-pages | ||
|
||
|
||
# TODO: replace the documentation generator with something that is still maintained. | ||
|
||
# - name: Generate Documentation | ||
|