UnitySteer icon indicating copy to clipboard operation
UnitySteer copied to clipboard

Code Docs with tutorial

Open GandaG opened this issue 9 years ago • 2 comments

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

GandaG avatar Jan 11 '16 00:01 GandaG

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

ricardojmendez avatar Jan 12 '16 09:01 ricardojmendez

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.

GandaG avatar Jan 12 '16 14:01 GandaG