Giter Club home page Giter Club logo

Comments (4)

ClemensU42 avatar ClemensU42 commented on May 25, 2024

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

from echo.

GaryHuan9 avatar GaryHuan9 commented on May 25, 2024

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.

from echo.

ClemensU42 avatar ClemensU42 commented on May 25, 2024

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

from echo.

GaryHuan9 avatar GaryHuan9 commented on May 25, 2024

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

from echo.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.