From 8e38be6b5d038b68e482daf14fe18efa1a095743 Mon Sep 17 00:00:00 2001 From: CursedRock17 Date: Sun, 21 Apr 2024 13:55:11 -0400 Subject: [PATCH] Renaming files Signed-off-by: CursedRock17 Removing exhale Signed-off-by: CursedRock17 Fixing doxyfile Signed-off-by: CursedRock17 Removing extra picture Signed-off-by: CursedRock17 --- tf2_ros/{docs => doc}/Doxyfile | 2 +- tf2_ros/{docs => doc}/Makefile | 0 tf2_ros/{docs/source => doc}/cli_tools.rst | 0 tf2_ros/{docs/source => doc}/conf.py | 22 +++++++++--------- .../source => doc}/images/rqt_tf_tree.png | Bin .../images/rviz2_screenshot.png | Bin .../source => doc}/images/view_frames.png | Bin tf2_ros/{docs/source => doc}/index.rst | 0 tf2_ros/{docs => doc}/mainpage.dox | 0 tf2_ros/{docs => doc}/make.bat | 0 tf2_ros/{docs/source => doc}/tf2_ros2.rst | 0 11 files changed, 12 insertions(+), 12 deletions(-) rename tf2_ros/{docs => doc}/Doxyfile (97%) rename tf2_ros/{docs => doc}/Makefile (100%) rename tf2_ros/{docs/source => doc}/cli_tools.rst (100%) rename tf2_ros/{docs/source => doc}/conf.py (95%) rename tf2_ros/{docs/source => doc}/images/rqt_tf_tree.png (100%) rename tf2_ros/{docs/source => doc}/images/rviz2_screenshot.png (100%) rename tf2_ros/{docs/source => doc}/images/view_frames.png (100%) rename tf2_ros/{docs/source => doc}/index.rst (100%) rename tf2_ros/{docs => doc}/mainpage.dox (100%) rename tf2_ros/{docs => doc}/make.bat (100%) rename tf2_ros/{docs/source => doc}/tf2_ros2.rst (100%) diff --git a/tf2_ros/docs/Doxyfile b/tf2_ros/doc/Doxyfile similarity index 97% rename from tf2_ros/docs/Doxyfile rename to tf2_ros/doc/Doxyfile index f63de797c..50b5cab03 100644 --- a/tf2_ros/docs/Doxyfile +++ b/tf2_ros/doc/Doxyfile @@ -6,7 +6,7 @@ PROJECT_BRIEF = "This package contains the ROS bindings for the tf2 lib INPUT = ../include ./mainpage.dox RECURSIVE = YES -OUTPUT_DIRECTORY = docs_output +OUTPUT_DIRECTORY = doc_output EXTRACT_ALL = YES SORT_MEMBER_DOCS = NO diff --git a/tf2_ros/docs/Makefile b/tf2_ros/doc/Makefile similarity index 100% rename from tf2_ros/docs/Makefile rename to tf2_ros/doc/Makefile diff --git a/tf2_ros/docs/source/cli_tools.rst b/tf2_ros/doc/cli_tools.rst similarity index 100% rename from tf2_ros/docs/source/cli_tools.rst rename to tf2_ros/doc/cli_tools.rst diff --git a/tf2_ros/docs/source/conf.py b/tf2_ros/doc/conf.py similarity index 95% rename from tf2_ros/docs/source/conf.py rename to tf2_ros/doc/conf.py index c2fd05eba..f180edbc5 100644 --- a/tf2_ros/docs/source/conf.py +++ b/tf2_ros/doc/conf.py @@ -214,17 +214,17 @@ ] # Configuration for breathe to link doxygen -breathe_projects = {'tf2_ros': './../docs_output/tf2_ros/generated/doxygen/xml'} -breathe_default_project = 'tf2_ros' - -# Exhale configuration -exhale_args = { - # Required arguments - "containmentFolder": "./api", - "rootFileName": "index.rst", - "doxygenStripFromPath": "..", - "rootFileTitle": "tf2_ros API", - } +# breathe_projects = {'tf2_ros': './generated/doxygen/xml'} +# breathe_default_project = 'tf2_ros' +# +# # Exhale configuration +# exhale_args = { +# # Required arguments +# "containmentFolder": "./api", +# "rootFileName": "index.rst", +# "doxygenStripFromPath": ".", +# "rootFileTitle": "tf2_ros API", +# } diff --git a/tf2_ros/docs/source/images/rqt_tf_tree.png b/tf2_ros/doc/images/rqt_tf_tree.png similarity index 100% rename from tf2_ros/docs/source/images/rqt_tf_tree.png rename to tf2_ros/doc/images/rqt_tf_tree.png diff --git a/tf2_ros/docs/source/images/rviz2_screenshot.png b/tf2_ros/doc/images/rviz2_screenshot.png similarity index 100% rename from tf2_ros/docs/source/images/rviz2_screenshot.png rename to tf2_ros/doc/images/rviz2_screenshot.png diff --git a/tf2_ros/docs/source/images/view_frames.png b/tf2_ros/doc/images/view_frames.png similarity index 100% rename from tf2_ros/docs/source/images/view_frames.png rename to tf2_ros/doc/images/view_frames.png diff --git a/tf2_ros/docs/source/index.rst b/tf2_ros/doc/index.rst similarity index 100% rename from tf2_ros/docs/source/index.rst rename to tf2_ros/doc/index.rst diff --git a/tf2_ros/docs/mainpage.dox b/tf2_ros/doc/mainpage.dox similarity index 100% rename from tf2_ros/docs/mainpage.dox rename to tf2_ros/doc/mainpage.dox diff --git a/tf2_ros/docs/make.bat b/tf2_ros/doc/make.bat similarity index 100% rename from tf2_ros/docs/make.bat rename to tf2_ros/doc/make.bat diff --git a/tf2_ros/docs/source/tf2_ros2.rst b/tf2_ros/doc/tf2_ros2.rst similarity index 100% rename from tf2_ros/docs/source/tf2_ros2.rst rename to tf2_ros/doc/tf2_ros2.rst