Giter VIP home page Giter VIP logo

Comments (4)

atgeirr avatar atgeirr commented on August 20, 2024

The intention was to have doxygen documentation from multiple libraries (opm-core and opm-polymer for example) in the same directory located in a common spot. It's probably better to build docs in a doc/ subdir of the library itself, feel free to change it as you go.

The script generate_doc_figures.py should be moved to the tutorials directory, or perhaps the doc/ dir. Xavier Raynaud works here at Sintef, if that is what you mean to ask...?

from opm-core.

rolk avatar rolk commented on August 20, 2024

Proposed patch at #115
I asked about Xavier because he is the prime author of the script, but he is not an OPM member on GitHub. Realized afterwards that it is of course because his commit has been automatically imported from SVN. (By me, of course, hello memory parity errors!)

from opm-core.

andlaus avatar andlaus commented on August 20, 2024

@atgeirr > The intention was to have doxygen documentation from multiple libraries (opm-core and opm-polymer for example) in the same directory located in a common spot.

I suppose that this does not work as it is currently implemented anyway: You will get clashes of file names (e.g. index.html, modules.html, and even the class documentation goes into a$NUMBER.html files if you do not change the Doxyfile). To achieve this anyway, one must copy all headers of all modules into the same directory ('make install'?) and then run doxygen from this directory.

from opm-core.

rolk avatar rolk commented on August 20, 2024

In the cmake branch this files has been moved to the tutorials/ directory and modified so that it takes the paths as command-line options (callable from build system).

from opm-core.

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.