File tree Expand file tree Collapse file tree 2 files changed +16
-0
lines changed Expand file tree Collapse file tree 2 files changed +16
-0
lines changed Original file line number Diff line number Diff line change 8
8
docc :
9
9
rm -rf docs/
10
10
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
Original file line number Diff line number Diff line change @@ -5,16 +5,30 @@ This repository contains the documentation for the WebKit Project.
5
5
## Build Documentation
6
6
7
7
### Preview Documentation Locally
8
+
9
+ This will bring up a local web server, so you can view the documentation locally.
10
+
8
11
```
9
12
make preview
10
13
```
11
14
12
15
### Docc Archive (Xcode)
16
+
17
+ Generate a DocC Archive that will be automatically imported into Xcode's documentation.
18
+
13
19
```
14
20
make docc
15
21
```
16
22
17
23
### GitHub Release
24
+
25
+ Generate documentation for a release on GitHub Pages.
26
+
18
27
```
19
28
make github
20
29
```
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.
You can’t perform that action at this time.
0 commit comments