mirror of
https://github.com/saymrwulf/onnxruntime.git
synced 2026-05-17 21:10:43 +00:00
6e134c2cc3
Adding support for generating API documentation with the Jazzy tool. It's a manual process now, but we can eventually make it a part of the release pipeline.
17 lines
650 B
Markdown
17 lines
650 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> --module-version $(cat VERSION_NUMBER)
|
|
```
|
|
|
|
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.
|