Coder Social home page Coder Social logo

Add links to docs about celero HOT 3 CLOSED

cdeil avatar cdeil commented on August 17, 2024
Add links to docs

from celero.

Comments (3)

DigitalInBlue avatar DigitalInBlue commented on August 17, 2024

Good comment. That would be a simple and useful change. I think it may also be helpful to capture some of the information in the codeproject.com articles inside Celero's own documentation.

from celero.

cdeil avatar cdeil commented on August 17, 2024

Thanks for writing this documentation!

I think having a section with links to good external tutorials or documentation at the end would still be helpful.

One possibility to get nice docs (table of content, search, versions) would be to use sphinx and host on readthedocs.

from celero.

DigitalInBlue avatar DigitalInBlue commented on August 17, 2024

Currently, the API uses Doxygen (http://www.stack.nl/~dimitri/doxygen/) to create human-consumable documentation. I think the long term solution here is to embed tutorials and user documentation into Celero to allow a documentation target in the project to generate a full web site of documentation for the tool.

from celero.

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.