You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
17 lines
737 B
17 lines
737 B
# Documentation
|
|
|
|
## Realm Objective-C
|
|
|
|
The documentation can be found at [realm.io/docs/objc/latest](https://realm.io/docs/objc/latest).
|
|
The API reference is located at [realm.io/docs/objc/latest/api](https://realm.io/docs/objc/latest/api).
|
|
|
|
## Realm Swift
|
|
|
|
The documentation can be found at [realm.io/docs/swift/latest](https://realm.io/docs/swift/latest).
|
|
The API reference is located at [realm.io/docs/swift/latest/api](https://realm.io/docs/swift/latest/api).
|
|
|
|
## Generating Docs
|
|
|
|
You can generate the API docs locally by running `sh build.sh docs` from the root of this repository.
|
|
This requires installation of [jazzy](https://github.com/realm/jazzy/).
|
|
You will find the output in `docs/swift_output/` and `docs/objc_output/`.
|
|
|