Add tutorial to index and use \image commands

Signed-off-by: Addisu Z. Taddese <[email protected]>
gazebosim · Sep 27, 2023 · 2c79db3 · 2c79db3
1 parent 9fc70ca
commit 2c79db3
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 3 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -173,6 +173,7 @@ configure_file(${CMAKE_SOURCE_DIR}/tutorials.md.in ${CMAKE_BINARY_DIR}/tutorials
 gz_create_docs(
   API_MAINPAGE_MD "${CMAKE_BINARY_DIR}/api.md"
   TUTORIALS_MAINPAGE_MD "${CMAKE_BINARY_DIR}/tutorials.md"
+  IMAGE_PATH_DIRS "${CMAKE_SOURCE_DIR}/tutorials/files"
   TAGFILES
     "${GZ-MATH_DOXYGEN_TAGFILE} = ${GZ-MATH_API_URL}"
 )

diff --git a/tutorials.md.in b/tutorials.md.in
@@ -8,6 +8,7 @@ Gazebo @GZ_DESIGNATION_CAP@ library and how to use the library effectively.
 
 1. \subpage install "Installation"
 2. \subpage cppgetstarted "C++ Get Started"
+3. \subpage messagegeneration "Message Generation"
 
 ## License
 

diff --git a/tutorials/message_generation.md b/tutorials/message_generation.md
@@ -80,7 +80,7 @@ place to make the messages usable across the Gazebo stack.
 To begin with, each message definition is passed through the `gz_msgs_protoc` 
 function:
 
-![gz_msgs_protoc](files/gz_msgs_protoc.svg)
+\image html files/gz_msgs_protoc.svg
 
 For each file:
 
@@ -102,7 +102,7 @@ scripts and executables:
 After individual message files have been generated, all of the definitions
 are grouped and processed via `gz_msgs_factory`
 
-![gz_msgs_factory](files/gz_msgs_factory.svg)
+\image html files/gz_msgs_factory.svg
 
 For the collection, `gz_msgs_factory` generates:
 
@@ -220,7 +220,7 @@ This allow for the messages to be used without any sort of reflection/introspect
 Include the headers and interact with the messages using the generated
 bindings according to the [language guide](https://protobuf.dev/reference/cpp/cpp-generated/)
 
-```c++
+```cpp
 #include <gz/custom_msgs/baz.pb.h>
 
 int main(int argc, char** argv)