Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Code Docs with tutorial #41

Open
dh-nunes opened this issue Jan 11, 2016 · 2 comments
Open

Code Docs with tutorial #41

dh-nunes opened this issue Jan 11, 2016 · 2 comments

Comments

@dh-nunes
Copy link
Contributor

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

@ricardojmendez
Copy link
Owner

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

@dh-nunes
Copy link
Contributor Author

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.

@ricardojmendez ricardojmendez self-assigned this Jan 17, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants