Git Product home page Git Product logo

Comments (4)

zerothi avatar zerothi commented on May 26, 2024

It would be great with the last 4 :)

In my preferential order: Github actions, codecov, pre-commit, ctest (I would probably like to do this one since I am still new to cmake, so getting my hands dirty is needed).

Thanks!!!

I am probably in favor of using ford for documentation. I want to support the fortran eco-system, and using that might be useful. :)

from fdict.

LecrisUT avatar LecrisUT commented on May 26, 2024

For ctest, you can try my example at spglib for a quick reference.

Does ford produce html/md/rst documentation? If so, we can still link it to readthedocs. I would strongly recommend RTD because it handles the api versioning automatically. As for sphinx, one advantage is that we can use include to synchronize the README.md text with generated documentation.

from fdict.

zerothi avatar zerothi commented on May 26, 2024

I know sphinx, and use it for other projects. ford is very similar to doxygen (can do md or rst AFAIK) and can still be used on RTD, so that isn't an issue.

ford, I am pretty sure, can do what you ask, but it has a focus on fortran :)

from fdict.

LecrisUT avatar LecrisUT commented on May 26, 2024

Sure, I do not have a preference for one or another. If you can make a simple instruction about the documentation, I can help link it to RTD and/or sphinx.

from fdict.

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.