Git Product home page Git Product logo

Comments (3)

gonuke avatar gonuke commented on July 23, 2024

I think it is good to have the API docs produced.

  • What kind of overhaul do you think they need? It's not clear from your comments above.
  • I've seen updated Doxygen templates that produce more nicely formatted API docs

from cyclus.

bennibbelink avatar bennibbelink commented on July 23, 2024

I apologize, I made this issue without fully exploring the API docs. I never realized that we had this thorough of API documentation, it looks like it could be really helpful.

  • The "Main Page" and the "Related Pages" are pretty bare, can we make it more user friendly from that standpoint and point users in the right direction when they land on the page?
  • How is this site updated? I haven't been able to find anything in cyclus/cyclus or cyclus/cyclus.github.com that points to publishing these docs. I am aware that it is a target in the Makefile if you build with doxygen in your environment.

from cyclus.

gonuke avatar gonuke commented on July 23, 2024

I think it gets built (can be built? Should be built?) as part of cyclus and deployed to that repo's gh-pages branch that is then published as: cyclus.github.io/cyclus which should also resolve as fuel cycle.org/cyclus

from cyclus.

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.