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/readme.md
Edward Chen 666aff56a4
Add workflow to update Objective-C docs. (#15413) 
Add workflow to update Objective-C API docs. Remove the Objective-C API doc generation step from the packaging pipeline.

There are similar workflows for automatically updating other language API docs. This change enables this for Objective-C too.
2023-04-07 15:00:15 -07:00

572 B
Raw Permalink Blame History

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.

To generate documentation, 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>.

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