Skip to content

Commit

Permalink
Use Docc for document generation (#59)
Browse files Browse the repository at this point in the history
* Remove docs

* Generate docs on CI

* Bump checkout action to v4
  • Loading branch information
ra1028 authored Jan 29, 2024
1 parent d58034a commit fac701a
Show file tree
Hide file tree
Showing 30 changed files with 38 additions and 6,207 deletions.
25 changes: 25 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# https://github.com/actions/virtual-environments

name: docs

on:
release:
types: [published]
workflow_dispatch:

env:
DEVELOPER_DIR: /Applications/Xcode_15.2.app

jobs:
publish-docs:
name: Publish Documentation
runs-on: macos-13
steps:
- uses: actions/checkout@v4
- name: Build docs
run: make docs
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs
4 changes: 2 additions & 2 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ jobs:
name: Validation
runs-on: macos-13
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4

- name: Get SwiftPM cache
uses: actions/cache@v2
Expand Down Expand Up @@ -42,7 +42,7 @@ jobs:
name: Test on macOS
runs-on: macos-13
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4
- name: Show environments
run: |
swift --version
Expand Down
7 changes: 4 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ node_modules
.swiftpm
.build

## Visual regression test
## Snapshot test
Snapshots
.reg
gcloud-service-key.json

## Documentation
docs
7 changes: 7 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,13 @@ format:
lint:
$(TOOL) swift-format lint -s -p -r Sources Tests

.PHONY: docs
docs:
xcodebuild docbuild \
-scheme PlaybookUI \
-destination generic/platform=iOS \
OTHER_DOCC_FLAGS="--transform-for-static-hosting --hosting-base-path playbook-ios --output-dir docs"

.PHONY: npm
npm:
npm i
Expand Down
275 changes: 0 additions & 275 deletions docs/Playbook/index.html

This file was deleted.

Loading

0 comments on commit fac701a

Please sign in to comment.