Skip to content

Commit ce3b866

Browse files
committed
Add information on importing doccarchive into Xcode
Adds easy steps to automatically import doccarchive into Xcode
1 parent ce13f47 commit ce3b866

File tree

2 files changed

+16
-0
lines changed

2 files changed

+16
-0
lines changed

Makefile

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,5 @@ preview:
88
docc:
99
rm -rf docs/
1010
xcodebuild docbuild -scheme WebKit -destination 'platform=macOS' -derivedDataPath ./docs
11+
echo "WebKit.doccarchive generated at docs/Build/Products/Debug/"
12+
open docs/Build/Products/Debug/WebKit.doccarchive

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,30 @@ This repository contains the documentation for the WebKit Project.
55
## Build Documentation
66

77
### Preview Documentation Locally
8+
9+
This will bring up a local web server, so you can view the documentation locally.
10+
811
```
912
make preview
1013
```
1114

1215
### Docc Archive (Xcode)
16+
17+
Generate a DocC Archive that will be automatically imported into Xcode's documentation.
18+
1319
```
1420
make docc
1521
```
1622

1723
### GitHub Release
24+
25+
Generate documentation for a release on GitHub Pages.
26+
1827
```
1928
make github
2029
```
30+
31+
## Import Documentation into Xcode
32+
33+
Open the WebKit.doccarchive and it will be automatically imported into Xcode.
34+
Running `make docc` will also launch Xcode and import the document.

0 commit comments

Comments
 (0)