Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Is it possible to include the steps required to build the documentation locally? #1202

Open
lwygzh opened this issue Dec 21, 2023 · 3 comments
Assignees

Comments

@lwygzh
Copy link

lwygzh commented Dec 21, 2023

Hi,

Would it be possible to include the steps required to build the doxygen-based documentation in the readme or somewhere else?

Additionally, I noticed that the documentation served online is for version 1.9.0. I was wondering if that can be updated.

Thanks!

@nim65s
Copy link
Collaborator

nim65s commented Dec 21, 2023

Building documentation is only a matter of setting the CMake BUILD_DOCUMENTATION option, which should be the case by default.

For the server, thanks for the notification, I'll fix this.

@lwygzh
Copy link
Author

lwygzh commented Dec 29, 2023

@nim65s Thanks for the response!

Is the version of the doc website fixed? It still seems like its version 1.9.0. The doc website for hpp-fcl is also outdated.

@lwygzh
Copy link
Author

lwygzh commented Jan 6, 2024

@nim65s I was able to build the documentation after building crocoddyl and running

doxygen Doxyfile

in the /path/to/crocoddyl/build/doc directory. However, the generated documentation does not have MathJax support. I see that there is a doxygen-html folder with something related to MathJax and a Doxyfile.extra file. Would it be possible to provide the command required to correctly build the documentation?

I think the problem is that the output (html files) should go into the doxygen-html folder, but somehow it created a new html file and directed all the outputs to go there. I think the CSS support is also gone.

Thanks!

@nim65s nim65s self-assigned this Jan 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants