Add cmake option for specifying that the doc github repo should be set up

Author: langmm

.github/workflows/docs.yml

@@ -22,7 +22,7 @@ jobs:
         run: |
           mkdir build
           cd build
-          cmake .. -DRAPIDJSON_BUILD_DOC=ON -DRAPIDJSON_BUILD_EXAMPLES=OFF -DRAPIDJSON_BUILD_TESTS=OFF
+          cmake .. -DRAPIDJSON_BUILD_DOC_FOR_PUBLISH=ON -DRAPIDJSON_BUILD_EXAMPLES=OFF -DRAPIDJSON_BUILD_TESTS=OFF
           cmake --build .
       - name: Add changes & push to deploy
         run: |

CMakeLists.txt

@@ -150,6 +150,10 @@ endif()
 SET(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
 
 option(RAPIDJSON_BUILD_DOC "Build rapidjson documentation." ON)
+option(RAPIDJSON_BUILD_DOC_FOR_PUBLISH "Build rapidjson documentation and prepare the html directory for publication to gh-pages branch" OFF)
+if(RAPIDJSON_BUILD_DOC_FOR_PUBLISH)
+    set(RAPIDJSON_BUILD_DOC ON)
+endif()
 option(RAPIDJSON_BUILD_EXAMPLES "Build rapidjson examples." ON)
 option(RAPIDJSON_BUILD_TESTS "Build rapidjson perftests and unittests." ON)
 option(RAPIDJSON_BUILD_THIRDPARTY_GTEST

doc/CMakeLists.txt

@@ -11,9 +11,17 @@ ELSE()
 
     file(GLOB DOXYFILES ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile*)
 
+    set(GIT_COMMANDS)
+    if(RAPIDJSON_BUILD_DOC_FOR_PUBLISH)
+        set(
+            GIT_COMMANDS
+            COMMAND git fetch origin gh-pages
+            COMMAND git worktree add -f ${CMAKE_CURRENT_BINARY_DIR}/html gh-pages
+        )
+    endif()
+
     add_custom_command(OUTPUT html
-        COMMAND git fetch origin gh-pages
-        COMMAND git worktree add -f ${CMAKE_CURRENT_BINARY_DIR}/html gh-pages
+        ${GIT_COMMANDS}
         COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
         COMMAND ${CMAKE_COMMAND} -E touch ${CMAKE_CURRENT_BINARY_DIR}/html
         DEPENDS ${MARKDOWN_DOC} ${SOURCES} ${DOXYFILES}

readme.md

@@ -137,7 +137,7 @@ to the gh-pages branch as below.
 ```
 mkdir build_docs
 cd build_docs
-cmake .. -DRAPIDJSON_BUILD_DOC=ON -DRAPIDJSON_BUILD_EXAMPLES=OFF -DRAPIDJSON_BUILD_TESTS=OFF
+cmake .. -DRAPIDJSON_BUILD_DOC_FOR_PUBLISH=ON -DRAPIDJSON_BUILD_EXAMPLES=OFF -DRAPIDJSON_BUILD_TESTS=OFF
 cmake --build .
 cd doc/html
 git add -A