sync repo source code with rel-1.15.0 and update yml files into two stages

2023-07-14 11:45:08 -07:00
parent a2f312d30e
commit 9f58d76d7c
29 changed files with 577 additions and 452 deletions
@@ -0,0 +1,17 @@
+# Objective-C API Documentation
+
+The API should be documented with comments in the [public header files](../include).
+
+## Documentation Generation
+
+The [Jazzy](https://github.com/realm/jazzy) tool is used to generate documentation from the code.
+
+To generate documentation, from the repo root, run:
+
+```bash
+jazzy --config objectivec/docs/jazzy_config.yaml --output <output directory>
+```
+
+The generated documentation website files will be in `<output directory>`.
+
+[main_page.md](./main_page.md) contains content for the main page of the generated documentation website.