Skip to content

Commit 5f3cc8b

Browse files
Update api-reference to point to generated docs
1 parent fff570d commit 5f3cc8b

1 file changed

Lines changed: 31 additions & 1 deletion

File tree

docs/source/api-reference.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,34 @@ title: API Reference
33
description: ''
44
---
55

6-
[Coming soon!]
6+
## [Apollo.framework](api/Apollo/README.md)
7+
## [ApolloSQLite.framework](api/ApolloSQLite/README.md)
8+
## [ApolloWebSocket.framework](api/ApolloWebSocket/README.md)
9+
10+
Our API reference is automatically generated directly from the inline comments in our code, so if you're adding something new, all you have to do is actually add doc comments and they'll show up here.
11+
12+
See something missing documentation? Add docu-comments to the code, and open a pull request!
13+
14+
To run the document generator, make sure you have [SourceDocs](https://github.com/eneko/SourceDocs) installed locally. The easiest way is via HomeBrew:
15+
16+
```
17+
brew install sourcedocs
18+
```
19+
20+
To generate docs for the main `Apollo` project, `cd` into the source root and run:
21+
22+
```
23+
sourcedocs generate --output-folder "docs/source/api/Apollo" -- -scheme Apollo -workspace Apollo.xcworkspace
24+
```
25+
26+
To generate docs for the `ApolloSQLite` project, `cd` into the source root and run:
27+
28+
```
29+
sourcedocs generate --output-folder "docs/source/api/ApolloSQLite" -- -scheme ApolloSQLite -workspace Apollo.xcworkspace
30+
```
31+
32+
To generate for docs the `ApolloWebSocket` project, `cd` into the source root and run:
33+
34+
```
35+
sourcedocs generate --output-folder "docs/source/api/ApolloWebSocket" -- -scheme ApolloWebSocket -workspace Apollo.xcworkspace
36+
```

0 commit comments

Comments
 (0)