From 94e224e87cc4f4d99e20a55acc0f4fd24fb32f25 Mon Sep 17 00:00:00 2001 From: Eugenio Collado Date: Wed, 30 Jul 2025 09:55:57 +0200 Subject: [PATCH 1/2] Docu Docs build cmake option Signed-off-by: Eugenio Collado --- .../ddsenabler/installation/cmake_options.rst | 33 ++++++++++++++++--- 1 file changed, 28 insertions(+), 5 deletions(-) diff --git a/ddsenabler_docs/docs/ddsenabler/installation/cmake_options.rst b/ddsenabler_docs/docs/ddsenabler/installation/cmake_options.rst index 86c35079..c7e5f725 100644 --- a/ddsenabler_docs/docs/ddsenabler/installation/cmake_options.rst +++ b/ddsenabler_docs/docs/ddsenabler/installation/cmake_options.rst @@ -14,6 +14,10 @@ These options allow the developer to enable/disable certain *eProsima DDS Enable .. warning:: These options are only for developers who installed *eProsima DDS Enabler* following the compilation steps described in :ref:`installation_sources_linux`. +*************** +General Options +*************** + .. list-table:: :header-rows: 1 @@ -26,11 +30,6 @@ These options allow the developer to enable/disable certain *eProsima DDS Enable - ``Release`` |br| ``Debug`` - ``Release`` - * - :class:`BUILD_DOCS` - - Build the *eProsima DDS Enabler* |br| documentation. |br| - - ``OFF`` |br| - ``ON`` - - ``OFF`` * - :class:`BUILD_TESTS` - Build the *eProsima DDS Enabler* tools and |br| documentation tests. - ``OFF`` |br| @@ -59,3 +58,27 @@ These options allow the developer to enable/disable certain *eProsima DDS Enable - ``OFF`` |br| ``ON`` - ``OFF`` + + +************************** +Documentation Build Option +************************** + +.. important:: + The following option is only relevant for building the local documentation project (`ddsenabler_docs`): + +.. list-table:: + :header-rows: 1 + + * - Option + - Description + - Possible values + - Default + * - :class:`BUILD_DOCS` + - Build the *eProsima DDS Enabler* |br| documentation. |br| + - ``OFF`` |br| + ``ON`` + - ``OFF`` + +.. note:: + Once built, the generated HTML documentation is located under ``build/ddsenabler_docs/html`` From aac36d8967e119716d6748587855fe8b7d6d1557 Mon Sep 17 00:00:00 2001 From: EugenioCollado <121509066+EugenioCollado@users.noreply.github.com> Date: Wed, 30 Jul 2025 12:32:27 +0200 Subject: [PATCH 2/2] Update ddsenabler_docs/docs/ddsenabler/installation/cmake_options.rst Co-authored-by: Raul Sanchez-Mateos Lizano Signed-off-by: EugenioCollado <121509066+EugenioCollado@users.noreply.github.com> --- ddsenabler_docs/docs/ddsenabler/installation/cmake_options.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ddsenabler_docs/docs/ddsenabler/installation/cmake_options.rst b/ddsenabler_docs/docs/ddsenabler/installation/cmake_options.rst index c7e5f725..75f0855b 100644 --- a/ddsenabler_docs/docs/ddsenabler/installation/cmake_options.rst +++ b/ddsenabler_docs/docs/ddsenabler/installation/cmake_options.rst @@ -65,7 +65,7 @@ Documentation Build Option ************************** .. important:: - The following option is only relevant for building the local documentation project (`ddsenabler_docs`): + The following option is only relevant for building the local documentation project (``ddsenabler_docs``): .. list-table:: :header-rows: 1