GithubHelp home page GithubHelp logo

"make doc" does not work about gtsam HOT 6 CLOSED

borglab avatar borglab commented on July 19, 2024
"make doc" does not work

from gtsam.

Comments (6)

acxz avatar acxz commented on July 19, 2024 1

@vegnesh

Note you need to call the CMakeLists.txt of the entire project, not the one in the doc/ folder to create all the make targets like doc. The project wide CMakeLists.txt would be called by cmake ../.. if you have a build folder inside the doc/ folder, instead of cmake .. which is what you did.

I just tried the following on my system:

git clone https://github.com/borglab/gtsam
cd gtsam/doc
mkdir build
cd build
cmake ../..
make doc

and that generated the docs properly.
I get the exact error based on the procedure you mentioned, which is fine since that process is not expected to work.

from gtsam.

vegnesh avatar vegnesh commented on July 19, 2024 1

@acxz Your method works. I had done what you had suggested previously. However, at that point doxygen was not installed in my machine and hence there was no target for 'doc' generated in the Makefile. Now, it seems to work. Sorry for creating confusion

from gtsam.

dellaert avatar dellaert commented on July 19, 2024

Is doxygen installed? cmake checks that..

from gtsam.

vegnesh avatar vegnesh commented on July 19, 2024

I have Doxygen installed, however there is no target named doc in the makefile generated using CMake.Is there a flag that needs to be enabled while creating the makefile to generate documentation?

from gtsam.

dellaert avatar dellaert commented on July 19, 2024

This par of the cmake code is quite old, and I'm no expert. It could be, or could be broken. If you do some digging and find out (or whomever is watching this) it would be highly appreciated. Probably a simple issue...

from gtsam.

jlblancoc avatar jlblancoc commented on July 19, 2024

To avoid users falling into these errors (which seem common when starting with cmake?), there is a solution: introducing an include(...) to the top of each CMakeLists.txt file except the root one, to do a check like this one.

Pros: avoids this kind of error.
Cons: it's "visually unpleasant" to see that include polluting the cmake files at all subdirectories! ;-)

Is it worth? I don't know :-)

from gtsam.

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.