Code Docs with tutorial

ricardojmendez / UnitySteer

Steering, obstacle avoidance and path following behaviors for the Unity Game Engine

https://numergent.com/tags/unitysteer/

Other

1.2k stars 274 forks source link

Code Docs with tutorial #41

Open GandaG opened 8 years ago

GandaG commented 8 years ago

While the examples are a nice start a full documentation with a tutorial for first time users is sorely needed.

ricardojmendez commented 8 years ago

We could handle this either with Github pages, for which I'd welcome pull requests, or via the wiki which is already open.

GandaG commented 8 years ago

Github pages will be most certainly a must, at the very least for the extracted xml/html from the actual code (ghostdoc/doxygen? can those be automated with travis/appveyor?)

What I don't know is if doxygen works like sphinx, which allows you to write your own pages in rst besides extracting the docstrings (python made me lazy). If not, the wiki would be used to write some first time tutorial and other tidbits that would need to be included.