mirror of
https://github.com/saymrwulf/onnxruntime.git
synced 2026-05-17 21:10:43 +00:00
395a7242d6
* Change storage container, simplify build definition parameters. * Remove explicit version from Objective-C docs. * Increase timeout. * Use real storage account. * Get static website URL with az cli.
17 lines
611 B
Markdown
17 lines
611 B
Markdown
# 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.
|
|
|
|
For example, to generate documentation for a release version, 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>`.
|
|
|
|
[docs.readme.md](./docs.readme.md) contains content for the main page of the generated documentation website.
|