saymrwulf/onnxruntime
1
0
Fork 0
mirror of https://github.com/saymrwulf/onnxruntime.git synced 2026-05-14 20:48:00 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
onnxruntime/objectivec/docs
History
Edward Chen 395a7242d6
[iOS packaging] Minor updates. (#10755) 
* 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.
2022-03-04 16:02:53 +10:00
..
docs.readme.md [Objective-C API] Add support for documentation generation (#7999) 2021-06-11 17:49:00 -07:00
jazzy_config.yaml [Objective-C API] Add support for documentation generation (#7999) 2021-06-11 17:49:00 -07:00
readme.md [iOS packaging] Minor updates. (#10755) 2022-03-04 16:02:53 +10:00

readme.md

Objective-C API Documentation

The API should be documented with comments in the public header files.

Documentation Generation

The Jazzy tool is used to generate documentation from the code.

For example, to generate documentation for a release version, from the repo root, run:

jazzy --config objectivec/docs/jazzy_config.yaml --output <output directory>

The generated documentation website files will be in <output directory>.

docs.readme.md contains content for the main page of the generated documentation website.