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

Employ a Documentation Generator #58

Closed
Wallacoloo opened this issue Dec 14, 2014 · 1 comment
Closed

Employ a Documentation Generator #58

Wallacoloo opened this issue Dec 14, 2014 · 1 comment

Comments

@Wallacoloo
Copy link
Owner

It would be useful to have actual documentation webpages, which can be automatically generated using tools like Doxygen. These tools also encourage consistency in how documentation is laid out internally (e.g. comments before each function, etc).

I haven't researched the choices, but I imagine there are some documentation generators that integrate well with github.

@Wallacoloo
Copy link
Owner Author

The devel branch now features integration with cldoc.

Now, a push to either the master or devel branch will trigger Travis CI to automatically build the documentation and push it to gh-pages (visible here).

It currently does not discriminate between master and devel branches. In the future, perhaps we can have both documentations side-by-side, or only have the gh-pages document the master branch.

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

1 participant