search

bakerstu / openmrn

OpenMRN (Open Model Railroad Network)
BSD 2-Clause "Simplified" License
57 stars 29 forks source link

consider publishing pre-built doxygen doc on github pages #74

Open balazsracz opened 7 years ago

balazsracz commented 7 years ago

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?

JohnSL commented 7 years ago

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.