Our developer-facing C# classes (Academy, Agent, Decision and Monitor) have been documented to be compatabile with Doxygen for auto-generating HTML documentation.
To generate the API reference,
download Doxygen and run
the following command within the docs/ directory:
doxygen dox-ml-agents.conf
dox-ml-agents.conf is a Doxygen configuration file for ML-Agents
that includes the classes that have been properly formatted.
The generated HTML files will be placed
in the html/ subdirectory. Open index.html within that subdirectory to
navigate to the API reference home. Note that html/ is already included in
the repository's .gitignore file.
In the near future, we aim to expand our documentation to include all the Unity C# classes and Python API.