Wallacoloo / printipi

3d printing directly through the Raspberry Pi's GPIO pins
MIT License
141 stars 43 forks source link

Employ a Documentation Generator #58

Closed Wallacoloo closed 9 years ago

Wallacoloo commented 9 years ago

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 commented 9 years ago

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.