Rename BUILD_DOCS to SPARROW_IPC_BUILD_DOCS for consistency

Author: Hind-M

.github/workflows/docs.yaml

@@ -21,7 +21,7 @@ jobs:
         cache-downloads: true
 
     - name: Configure using CMake
-      run: cmake -G Ninja -Bbuild -DCMAKE_BUILD_TYPE:STRING=Debug -DCMAKE_INSTALL_PREFIX=$CONDA_PREFIX -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DBUILD_DOCS=ON 
+      run: cmake -G Ninja -Bbuild -DCMAKE_BUILD_TYPE:STRING=Debug -DCMAKE_INSTALL_PREFIX=$CONDA_PREFIX -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DSPARROW_IPC_BUILD_DOCS=ON
 
     - name: Build docs target
       run: cmake --build build --target docs

CMakeLists.txt

@@ -44,8 +44,8 @@ endif()
 OPTION(SPARROW_IPC_BUILD_TESTS "Build sparrow-ipc test suite" OFF)
 MESSAGE(STATUS "🔧 Build tests: ${SPARROW_IPC_BUILD_TESTS}")
 
-OPTION(BUILD_DOCS  "Build sparrow-ipc documentation" OFF)
-MESSAGE(STATUS "🔧 Build docs: ${BUILD_DOCS}")
+OPTION(SPARROW_IPC_BUILD_DOCS  "Build sparrow-ipc documentation" OFF)
+MESSAGE(STATUS "🔧 Build docs: ${SPARROW_IPC_BUILD_DOCS}")
 
 # Code coverage
 # =============
@@ -175,7 +175,7 @@ endif()
 
 # Docs
 # ====
-if(BUILD_DOCS)
+if(SPARROW_IPC_BUILD_DOCS)
     message(STATUS "📚 Create docs targets")
     add_subdirectory(docs)
 endif()

conanfile.py

@@ -88,7 +88,7 @@ def generate(self):
         tc = CMakeToolchain(self)
         tc.variables["SPARROW_IPC_BUILD_SHARED"] = self.options.shared
         tc.variables["SPARROW_IPC_BUILD_TESTS"] = self.options.build_tests
-        tc.variables["BUILD_DOCS"] = self.options.generate_documentation
+        tc.variables["SPARROW_IPC_BUILD_DOCS"] = self.options.generate_documentation
         tc.generate()
 
     def build(self):

docs/source/dev_build.md

@@ -7,7 +7,7 @@ List of CMake options:
 - `ACTIVATE_LINTER`: Create targets to run clang-format and clang-tidy (default: OFF)
 - `ACTIVATE_LINTER_DURING_COMPILATION`: Run linter during the compilation (default: OFF),
   requires `ACTIVATE_LINTER` to be ON
-- `BUILD_DOCS`: Build the documentation (default: OFF)
+- `SPARROW_IPC_BUILD_DOCS`: Build the documentation (default: OFF)
 - `SPARROW_IPC_BUILD_TESTS`: Build the tests (default: OFF)
 - `SPARROW_IPC_BUILD_SHARED`: Build sparrow-ipc as a shared library (default: ON)
 - `SPARROW_IPC_ENABLE_COVERAGE`: Enable coverage reporting (default: OFF)