Finalized doxygen pages #466
Conversation
mmattar
commented
Mar 14, 2018
mmattar
commented
- Limited to C# classes that are user-facing
- Added a placeholder for Python to signify intentions
- Generated doxygen pages
- Limited to C# classes that are user-facing/ - Added a placeholder for Python to signify intentions - Generated doxygen pages
mmattar
requested review from
awjuliani,
eshvk,
jo3w4rd,
vincentpierre and
xiaomaogy
|
Are we supposed to have the doxygen documents in the repo ? Shouldn't this be hosted somewhere ? |
|
Keeping generated files in the repo is usually bad practice. |
|
In this case, it lets us host the docs, including the API reference, from Github (using github pages). |
|
@jo3w4rd - we should do that for the next (minor) release. For now, I've updated the pages to provide documentation on how to generate them yourself. @vincentpierre + @vladimiroster : please review new version. |
|
Do we have a ml-agents.conf file anywhere? I don't see it in the repo, and not in this pull request, but it is noted in the API-Reference.md. |
|
The file is named "dox-ml-agents.conf". Were you planning to rename it @mmattar? |
|
Great catch folks - the current name works for me. Just pushed a change. |
# Conflicts: # docs/doxygen/Readme.md
jo3w4rd
left a comment
jo3w4rd
left a comment
There was a problem hiding this comment.
We will need to make it more clear which parts of the API a developer needs to use and which parts are internal. But that's a bigger project then we should bite off right now.
docs/API-Reference.md
Outdated
|
|
||
| doxygen dox-ml-agents.conf | ||
|
|
||
| `ml-agents.conf` is a configuration file that includes the classes |
There was a problem hiding this comment.
ml-agents.conf ---> dox-ml-agents.conf
| Feature-Monitor.md \ | ||
| Limitations-and-Common-Issues.md \ | ||
| ../unity-environment/Assets/ML-Agents/Scripts \ | ||
| ../python/unityagents |
There was a problem hiding this comment.
Why do we only include a portion of the files in the ../unity-environment/Assets/ML-Agents/Scripts and ignoring files like Communicator.cs and BCTeacherHelper.cs?
There was a problem hiding this comment.
We've only included the files that the developers will be using or extending. We do need to add ALL in the future.
