cFS icon indicating copy to clipboard operation
cFS copied to clipboard

Publish html version of users guide and leverage github pages

Open astrogeco opened this issue 5 years ago • 6 comments

Is your feature request related to a problem? Please describe. The current deploy of the documentation is a pdf that while useful, could be better implemented as a webpage which doxygen already generates.

Describe the solution you'd like Leverage github pages to host a "live" version of the users guide.

Describe alternatives you've considered figure out how to get doxygen to generate markdown instead of html and use Jekyll or another static site generator

Requester Info Gerardo E. Cruz-Ortiz, NASA-GSFC

astrogeco avatar Jun 22 '20 19:06 astrogeco

Just a note that my experience in using the HTML was dreadful. You can't search, it's 100's (or 1000's) of random files... I hated that version and would prefer to not even make it to begin with. The PDF in my experience is WAY more useful... with an index, etc.

skliper avatar Jun 22 '20 19:06 skliper

Just a note that my experience in using the HTML was dreadful. You can't search, it's 100's (or 1000's) of random files... I hated that version and would prefer to not even make it to begin with. The PDF in my experience is WAY more useful... with an index, etc.

Maybe have both? That's sad that the html is bad. I was hoping it would be like https://pmarsceill.github.io/just-the-docs/

astrogeco avatar Jun 22 '20 20:06 astrogeco

Feel free if you find it useful. I didn't, it's terrible. The PDF looks way better.

skliper avatar Jun 22 '20 20:06 skliper

Can we close this, with the PDF's being sufficient?

skliper avatar Jul 23 '20 18:07 skliper

I don't think they are. What's the harm in leaving it open? To be explicit, i think we can improve on the pdfs. It doesn't have to be the doxy-generated html but i think a web version of the docs woukd be valuable

astrogeco avatar Jul 23 '20 20:07 astrogeco

No harm, just wanted to make sure it was still an active enhancement request.

skliper avatar Jul 23 '20 20:07 skliper