GaryHuan9 / Echo

An awesome ray traced 3D renderer build in C# from scratch!
MIT License
18 stars 3 forks source link

[Feature Request] Create Documentation for Echo #34

Open ClemensU42 opened 2 years ago

ClemensU42 commented 2 years ago

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

GaryHuan9 commented 2 years ago

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.

ClemensU42 commented 2 years ago

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

GaryHuan9 commented 2 years ago

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