Skip to content

Commit c11c41c

Browse files
regenerate with prefix to go back a directory
1 parent c5190d4 commit c11c41c

4 files changed

Lines changed: 96 additions & 92 deletions

File tree

docs/source/api-reference.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ To generate docs for the main `Apollo` project, `cd` into the source root and ru
2626
```
2727
sourcedocs generate \
2828
--output-folder "docs/source/api/Apollo" \
29+
--link-beginning "../" \
2930
--link-ending "/" \
3031
-- \
3132
-scheme Apollo \
@@ -37,6 +38,7 @@ To generate docs for the `ApolloSQLite` project, `cd` into the source root and r
3738
```
3839
sourcedocs generate \
3940
--output-folder "docs/source/api/ApolloSQLite" \
41+
--link-beginning "../" \
4042
--link-ending "/" \
4143
-- \
4244
-scheme ApolloSQLite \
@@ -48,6 +50,7 @@ To generate for docs the `ApolloWebSocket` project, `cd` into the source root an
4850
```
4951
sourcedocs generate \
5052
--output-folder "docs/source/api/ApolloWebSocket" \
53+
--link-beginning "../" \
5154
--link-ending "/" \
5255
-- \
5356
-scheme ApolloWebSocket \
@@ -68,6 +71,7 @@ For example, this will run the generator for `ApolloWebSocket`:
6871
swift run sourcedocs generate \
6972
--input-folder "/Users/[you]/apollo-ios" \
7073
--output-folder "/Users/[you]/apollo-ios/docs/source/api/ApolloWebSocket" \
74+
--link-beginning "../" \
7175
--link-ending "/" \
7276
-- \
7377
-scheme "ApolloWebSocket" \

docs/source/api/Apollo/README.md

Lines changed: 82 additions & 82 deletions
Original file line numberDiff line numberDiff line change
@@ -1,102 +1,102 @@
11
## Protocols
22

3-
- [Cancellable](protocols/Cancellable/)
4-
- [GraphQLFragment](protocols/GraphQLFragment/)
5-
- [GraphQLInputValue](protocols/GraphQLInputValue/)
6-
- [GraphQLMapConvertible](protocols/GraphQLMapConvertible/)
7-
- [GraphQLMutation](protocols/GraphQLMutation/)
8-
- [GraphQLOperation](protocols/GraphQLOperation/)
9-
- [GraphQLQuery](protocols/GraphQLQuery/)
10-
- [GraphQLSelection](protocols/GraphQLSelection/)
11-
- [GraphQLSelectionSet](protocols/GraphQLSelectionSet/)
12-
- [GraphQLSubscription](protocols/GraphQLSubscription/)
13-
- [HTTPNetworkTransportDelegate](protocols/HTTPNetworkTransportDelegate/)
14-
- [HTTPNetworkTransportPreflightDelegate](protocols/HTTPNetworkTransportPreflightDelegate/)
15-
- [HTTPNetworkTransportRetryDelegate](protocols/HTTPNetworkTransportRetryDelegate/)
16-
- [HTTPNetworkTransportTaskCompletedDelegate](protocols/HTTPNetworkTransportTaskCompletedDelegate/)
17-
- [JSONDecodable](protocols/JSONDecodable/)
18-
- [JSONEncodable](protocols/JSONEncodable/)
19-
- [Matchable](protocols/Matchable/)
20-
- [NetworkTransport](protocols/NetworkTransport/)
21-
- [NormalizedCache](protocols/NormalizedCache/)
3+
- [Cancellable](../protocols/Cancellable/)
4+
- [GraphQLFragment](../protocols/GraphQLFragment/)
5+
- [GraphQLInputValue](../protocols/GraphQLInputValue/)
6+
- [GraphQLMapConvertible](../protocols/GraphQLMapConvertible/)
7+
- [GraphQLMutation](../protocols/GraphQLMutation/)
8+
- [GraphQLOperation](../protocols/GraphQLOperation/)
9+
- [GraphQLQuery](../protocols/GraphQLQuery/)
10+
- [GraphQLSelection](../protocols/GraphQLSelection/)
11+
- [GraphQLSelectionSet](../protocols/GraphQLSelectionSet/)
12+
- [GraphQLSubscription](../protocols/GraphQLSubscription/)
13+
- [HTTPNetworkTransportDelegate](../protocols/HTTPNetworkTransportDelegate/)
14+
- [HTTPNetworkTransportPreflightDelegate](../protocols/HTTPNetworkTransportPreflightDelegate/)
15+
- [HTTPNetworkTransportRetryDelegate](../protocols/HTTPNetworkTransportRetryDelegate/)
16+
- [HTTPNetworkTransportTaskCompletedDelegate](../protocols/HTTPNetworkTransportTaskCompletedDelegate/)
17+
- [JSONDecodable](../protocols/JSONDecodable/)
18+
- [JSONEncodable](../protocols/JSONEncodable/)
19+
- [Matchable](../protocols/Matchable/)
20+
- [NetworkTransport](../protocols/NetworkTransport/)
21+
- [NormalizedCache](../protocols/NormalizedCache/)
2222

2323
## Structs
2424

25-
- [GraphQLBooleanCondition](structs/GraphQLBooleanCondition/)
26-
- [GraphQLError](structs/GraphQLError/)
27-
- [GraphQLField](structs/GraphQLField/)
28-
- [GraphQLFile](structs/GraphQLFile/)
29-
- [GraphQLFragmentSpread](structs/GraphQLFragmentSpread/)
30-
- [GraphQLHTTPResponseError](structs/GraphQLHTTPResponseError/)
31-
- [GraphQLResult](structs/GraphQLResult/)
32-
- [GraphQLResultError](structs/GraphQLResultError/)
33-
- [GraphQLTypeCase](structs/GraphQLTypeCase/)
34-
- [GraphQLTypeCondition](structs/GraphQLTypeCondition/)
35-
- [GraphQLVariable](structs/GraphQLVariable/)
36-
- [Location](structs/Location/)
37-
- [Record](structs/Record/)
38-
- [RecordSet](structs/RecordSet/)
39-
- [Reference](structs/Reference/)
25+
- [GraphQLBooleanCondition](../structs/GraphQLBooleanCondition/)
26+
- [GraphQLError](../structs/GraphQLError/)
27+
- [GraphQLField](../structs/GraphQLField/)
28+
- [GraphQLFile](../structs/GraphQLFile/)
29+
- [GraphQLFragmentSpread](../structs/GraphQLFragmentSpread/)
30+
- [GraphQLHTTPResponseError](../structs/GraphQLHTTPResponseError/)
31+
- [GraphQLResult](../structs/GraphQLResult/)
32+
- [GraphQLResultError](../structs/GraphQLResultError/)
33+
- [GraphQLTypeCase](../structs/GraphQLTypeCase/)
34+
- [GraphQLTypeCondition](../structs/GraphQLTypeCondition/)
35+
- [GraphQLVariable](../structs/GraphQLVariable/)
36+
- [Location](../structs/Location/)
37+
- [Record](../structs/Record/)
38+
- [RecordSet](../structs/RecordSet/)
39+
- [Reference](../structs/Reference/)
4040

4141
## Classes
4242

43-
- [ApolloClient](classes/ApolloClient/)
44-
- [ApolloStore](classes/ApolloStore/)
45-
- [EmptyCancellable](classes/EmptyCancellable/)
46-
- [GraphQLQueryWatcher](classes/GraphQLQueryWatcher/)
47-
- [GraphQLResponse](classes/GraphQLResponse/)
48-
- [HTTPNetworkTransport](classes/HTTPNetworkTransport/)
49-
- [InMemoryNormalizedCache](classes/InMemoryNormalizedCache/)
50-
- [JSONSerializationFormat](classes/JSONSerializationFormat/)
51-
- [Promise](classes/Promise/)
52-
- [ReadTransaction](classes/ReadTransaction/)
53-
- [ReadWriteTransaction](classes/ReadWriteTransaction/)
43+
- [ApolloClient](../classes/ApolloClient/)
44+
- [ApolloStore](../classes/ApolloStore/)
45+
- [EmptyCancellable](../classes/EmptyCancellable/)
46+
- [GraphQLQueryWatcher](../classes/GraphQLQueryWatcher/)
47+
- [GraphQLResponse](../classes/GraphQLResponse/)
48+
- [HTTPNetworkTransport](../classes/HTTPNetworkTransport/)
49+
- [InMemoryNormalizedCache](../classes/InMemoryNormalizedCache/)
50+
- [JSONSerializationFormat](../classes/JSONSerializationFormat/)
51+
- [Promise](../classes/Promise/)
52+
- [ReadTransaction](../classes/ReadTransaction/)
53+
- [ReadWriteTransaction](../classes/ReadWriteTransaction/)
5454

5555
## Enums
5656

57-
- [CachePolicy](enums/CachePolicy/)
58-
- [ErrorKind](enums/ErrorKind/)
59-
- [GraphQLHTTPRequestError](enums/GraphQLHTTPRequestError/)
60-
- [GraphQLOperationType](enums/GraphQLOperationType/)
61-
- [GraphQLOutputType](enums/GraphQLOutputType/)
62-
- [JSONDecodingError](enums/JSONDecodingError/)
63-
- [ResultOrPromise](enums/ResultOrPromise/)
64-
- [Source](enums/Source/)
57+
- [CachePolicy](../enums/CachePolicy/)
58+
- [ErrorKind](../enums/ErrorKind/)
59+
- [GraphQLHTTPRequestError](../enums/GraphQLHTTPRequestError/)
60+
- [GraphQLOperationType](../enums/GraphQLOperationType/)
61+
- [GraphQLOutputType](../enums/GraphQLOutputType/)
62+
- [JSONDecodingError](../enums/JSONDecodingError/)
63+
- [ResultOrPromise](../enums/ResultOrPromise/)
64+
- [Source](../enums/Source/)
6565

6666
## Extensions
6767

68-
- [Array](extensions/Array/)
69-
- [Bool](extensions/Bool/)
70-
- [Dictionary](extensions/Dictionary/)
71-
- [Double](extensions/Double/)
72-
- [Float](extensions/Float/)
73-
- [GraphQLError](extensions/GraphQLError/)
74-
- [GraphQLMapConvertible](extensions/GraphQLMapConvertible/)
75-
- [GraphQLMutation](extensions/GraphQLMutation/)
76-
- [GraphQLOperation](extensions/GraphQLOperation/)
77-
- [GraphQLQuery](extensions/GraphQLQuery/)
78-
- [GraphQLSelectionSet](extensions/GraphQLSelectionSet/)
79-
- [GraphQLSubscription](extensions/GraphQLSubscription/)
80-
- [GraphQLVariable](extensions/GraphQLVariable/)
81-
- [Int](extensions/Int/)
82-
- [JSONDecodingError](extensions/JSONDecodingError/)
83-
- [JSONEncodable](extensions/JSONEncodable/)
84-
- [Optional](extensions/Optional/)
85-
- [RawRepresentable](extensions/RawRepresentable/)
86-
- [Record](extensions/Record/)
87-
- [RecordSet](extensions/RecordSet/)
88-
- [Reference](extensions/Reference/)
89-
- [String](extensions/String/)
90-
- [URL](extensions/URL/)
68+
- [Array](../extensions/Array/)
69+
- [Bool](../extensions/Bool/)
70+
- [Dictionary](../extensions/Dictionary/)
71+
- [Double](../extensions/Double/)
72+
- [Float](../extensions/Float/)
73+
- [GraphQLError](../extensions/GraphQLError/)
74+
- [GraphQLMapConvertible](../extensions/GraphQLMapConvertible/)
75+
- [GraphQLMutation](../extensions/GraphQLMutation/)
76+
- [GraphQLOperation](../extensions/GraphQLOperation/)
77+
- [GraphQLQuery](../extensions/GraphQLQuery/)
78+
- [GraphQLSelectionSet](../extensions/GraphQLSelectionSet/)
79+
- [GraphQLSubscription](../extensions/GraphQLSubscription/)
80+
- [GraphQLVariable](../extensions/GraphQLVariable/)
81+
- [Int](../extensions/Int/)
82+
- [JSONDecodingError](../extensions/JSONDecodingError/)
83+
- [JSONEncodable](../extensions/JSONEncodable/)
84+
- [Optional](../extensions/Optional/)
85+
- [RawRepresentable](../extensions/RawRepresentable/)
86+
- [Record](../extensions/Record/)
87+
- [RecordSet](../extensions/RecordSet/)
88+
- [Reference](../extensions/Reference/)
89+
- [String](../extensions/String/)
90+
- [URL](../extensions/URL/)
9191

9292
## Methods
9393

94-
- [firstly(_:)](methods/firstly(_:)/)
95-
- [unzip(_:)](methods/unzip(_:)/)
96-
- [unzip(_:)](methods/unzip(_:)/)
97-
- [unzip(_:count:)](methods/unzip(_:count:)/)
98-
- [whenAll(_:notifyOn:)](methods/whenAll(_:notifyOn:)/)
99-
- [whenAll(_:notifyOn:)](methods/whenAll(_:notifyOn:)/)
94+
- [firstly(_:)](../methods/firstly(_:)/)
95+
- [unzip(_:)](../methods/unzip(_:)/)
96+
- [unzip(_:)](../methods/unzip(_:)/)
97+
- [unzip(_:count:)](../methods/unzip(_:count:)/)
98+
- [whenAll(_:notifyOn:)](../methods/whenAll(_:notifyOn:)/)
99+
- [whenAll(_:notifyOn:)](../methods/whenAll(_:notifyOn:)/)
100100

101101
# Reference Documentation
102102
This reference documentation was generated with

docs/source/api/ApolloSQLite/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11

22
## Classes
33

4-
- [SQLiteNormalizedCache](classes/SQLiteNormalizedCache/)
4+
- [SQLiteNormalizedCache](../classes/SQLiteNormalizedCache/)
55

66
## Enums
77

8-
- [SQLiteNormalizedCacheError](enums/SQLiteNormalizedCacheError/)
8+
- [SQLiteNormalizedCacheError](../enums/SQLiteNormalizedCacheError/)
99

1010
# Reference Documentation
1111
This reference documentation was generated with

docs/source/api/ApolloWebSocket/README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
11
## Protocols
22

3-
- [ApolloWebSocketClient](protocols/ApolloWebSocketClient/)
4-
- [WebSocketTransportDelegate](protocols/WebSocketTransportDelegate/)
3+
- [ApolloWebSocketClient](../protocols/ApolloWebSocketClient/)
4+
- [WebSocketTransportDelegate](../protocols/WebSocketTransportDelegate/)
55

66
## Structs
77

8-
- [WebSocketError](structs/WebSocketError/)
8+
- [WebSocketError](../structs/WebSocketError/)
99

1010
## Classes
1111

12-
- [ApolloWebSocket](classes/ApolloWebSocket/)
13-
- [SplitNetworkTransport](classes/SplitNetworkTransport/)
14-
- [WebSocketTransport](classes/WebSocketTransport/)
12+
- [ApolloWebSocket](../classes/ApolloWebSocket/)
13+
- [SplitNetworkTransport](../classes/SplitNetworkTransport/)
14+
- [WebSocketTransport](../classes/WebSocketTransport/)
1515

1616
## Enums
1717

18-
- [ErrorKind](enums/ErrorKind/)
18+
- [ErrorKind](../enums/ErrorKind/)
1919

2020
## Extensions
2121

22-
- [WebSocketTransportDelegate](extensions/WebSocketTransportDelegate/)
22+
- [WebSocketTransportDelegate](../extensions/WebSocketTransportDelegate/)
2323

2424
# Reference Documentation
2525
This reference documentation was generated with

0 commit comments

Comments
 (0)