openmrn icon indicating copy to clipboard operation
openmrn copied to clipboard

consider publishing pre-built doxygen doc on github pages

Open balazsracz opened this issue 7 years ago • 1 comments

GitHub pages might be a good opportunity to publish the generated doxygen documentation. I think it would involve a separate repository on which to enable github pages and some Makefile magic for updating it. Updating would be a manual task.

thoughts?

balazsracz avatar Jun 25 '17 13:06 balazsracz

I really like the idea of making the documentation more accessible. I was thinking about doxygen this morning vs GitHub markdown and debating the pros of cons of having the documentation in doxygen rather than in md files. Another option would be to separate the documentation. Keep doxygen for documenting the libraries. And use md files for user documentation. What do you think? I'd be happy to convert the existing non-library documentation into md files.

JohnSL avatar Jun 25 '17 16:06 JohnSL