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

Support images on tutorials generated with make doc #54

Closed
osrf-migration opened this issue Mar 19, 2019 · 2 comments
Closed

Support images on tutorials generated with make doc #54

osrf-migration opened this issue Mar 19, 2019 · 2 comments
Labels
enhancement New feature or request major

Comments

@osrf-migration
Copy link

Original report (archived issue) by Louise Poubel (Bitbucket: chapulina, GitHub: chapulina).


Summary

When running make doc, markdown tutorials under the tutorials folder are turned into HTML under the doxygen/html folder. It would be nice to also copy images from that directory so that they can be uploaded together with the generated HTML to the same server.

Motivation

Using images in tutorials is very important.

Describe alternatives you've considered

It's already possible to use HTML directly in tutorials and pass full URLs that point to other sites. However, this means that the generated documentation is not self-contained.

@osrf-migration osrf-migration added major enhancement New feature or request labels Apr 15, 2020
@chapulina
Copy link
Contributor

This is already supported by using doxygen's @image. All the library needs to do is a CMake command like this to copy the images to the doxygen folder:

file(COPY ${CMAKE_SOURCE_DIR}/tutorials/img/ DESTINATION ${CMAKE_BINARY_DIR}/doxygen/html/img/)

We could consider adding this line to ign_create_docs, or just keep adding it to each library as needed.

@azeey
Copy link
Contributor

azeey commented Oct 5, 2023

The @image or \image tag now works with the fix in #183.

@azeey azeey closed this as completed Oct 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request major
Projects
None yet
Development

No branches or pull requests

3 participants