Echo icon indicating copy to clipboard operation
Echo copied to clipboard

[Feature Request] Create Documentation for Echo

Open ClemensU42 opened this issue 2 years ago • 4 comments

ClemensU42 avatar Jun 28 '22 19:06 ClemensU42

@GaryHuan9 what do you think about using Doxygen for documentation?

ClemensU42 avatar Jul 19 '22 09:07 ClemensU42

Okay so your comment led me to some more digging. Originally, I was thinking about using readthedocs.org, but I have never heard of Doxygen before. I briefly looked at its website and I think we can definitely use it for our Echo.Core code API. Now it looks like our best option is to use GitHub pages and Sphinx to generate the documentation for using Echo actually as a renderer (rather than a code API). It would be the best if we can also put Doxygen into Sphinx.

GaryHuan9 avatar Jul 19 '22 14:07 GaryHuan9

Here's a link to Breathe, a tool that enables you to use both Sphinx and Doxygen: https://breathe.readthedocs.io/en/latest/

ClemensU42 avatar Jul 19 '22 17:07 ClemensU42

That looks good, we can definitely use it when we create our documentation.

GaryHuan9 avatar Jul 19 '22 17:07 GaryHuan9