search

andrewrapp / xbee-arduino

Arduino library for communicating with XBee radios in API mode
GNU General Public License v2.0
334 stars 162 forks source link

Publish doxygen docs through gh-pages #10

Open matthijskooijman opened 8 years ago

matthijskooijman commented 8 years ago

It seems doxygen docs are no longer available since github does not allow direct viewing of HTML files. However, it seems that by using gh-pages, you can again easily display HTML pages. This does mean that the HTML will be stored in a repository separate from the main repository, but that actually seems like a feature to me.

See this writeup for an example of how to set this up: http://rickfoosusa.blogspot.nl/2011/10/howto-use-doxygen-with-github.html

matthijskooijman commented 8 years ago

Another attractive alternative could be to have readthedocs.org generate and publish the docs automatically. RTD is aimed at python documentation using sphinx, but it can also be made to generate doxygen documentation and also add separate overview documentation using the powerful rst format as well.

andrewrapp commented 8 years ago

It seems that doxygen now supports markdown https://www.stack.nl/~dimitri/doxygen/manual/markdown.html