o3de / sig-docs-community

Resources for the Open 3D Engine Documentation & Community Special Interest Group (SIG)
Apache License 2.0
11 stars 9 forks source link

Instructions for C++ API Reference generation #114

Closed chanmosq closed 1 year ago

chanmosq commented 1 year ago

Document the C++ API Reference Generation process as it is. The process is long and manual, and lots of improvements can be made. But for now, document it as it is, so another can follow and be able to generate the API Ref and publish it to o3de.org website.

The scripts must also be published alongside the document. A good location to put both the doc and the scripts is in the sig-docs-community repository. Before publishing the script, make sure they work as expected and there are no outdated information