[scripts] Move doxygen/ under docs/

dartsim · Mar 17, 2024 · 75df8cf · 75df8cf
1 parent 4789e13
commit 75df8cf
Show file tree

Hide file tree

Showing 7 changed files with 20 additions and 9 deletions.
diff --git a/.gitignore b/.gitignore
@@ -53,7 +53,7 @@ TAGS
 /nbproject/
 
 # Doxygen documentation
-/doxygen/html/
+docs/doxygen/html/
 
 # Sphinx documentation
 docs/readthedocs/site

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -591,14 +591,14 @@ endif()
 #===============================================================================
 if(DOXYGEN_FOUND)
 
-  set(DOXYGEN_DOXYFILE_IN      "${PROJECT_SOURCE_DIR}/doxygen/Doxyfile.in"    )
-  set(DOXYGEN_DOXYFILE         "${PROJECT_BINARY_DIR}/doxygen/Doxyfile"       )
-  set(DOXYGEN_HTML_INDEX       "${PROJECT_BINARY_DIR}/doxygen/html/index.html")
-  set(DOXYGEN_OUTPUT_ROOT      "${PROJECT_BINARY_DIR}/doxygen/html"           )
+  set(DOXYGEN_DOXYFILE_IN      "${PROJECT_SOURCE_DIR}/docs/doxygen/Doxyfile.in"    )
+  set(DOXYGEN_DOXYFILE         "${PROJECT_BINARY_DIR}/docs/doxygen/Doxyfile"       )
+  set(DOXYGEN_HTML_INDEX       "${PROJECT_BINARY_DIR}/docs/doxygen/html/index.html")
+  set(DOXYGEN_OUTPUT_ROOT      "${PROJECT_BINARY_DIR}/docs/doxygen/html"           )
   set(DOXYGEN_GENERATE_TAGFILE "${DOXYGEN_OUTPUT_ROOT}/${PROJECT_NAME}.tag"   )
   set(DOXYGEN_INCLUDE_PATH     "${PROJECT_SOURCE_DIR}"                        )
   set(DOXYGEN_INPUT_ROOT       "${PROJECT_SOURCE_DIR}/dart"                   )
-  set(DOXYGEN_EXTRA_INPUTS     "${PROJECT_SOURCE_DIR}/doxygen/mainpage.dox"   )
+  set(DOXYGEN_EXTRA_INPUTS     "${PROJECT_SOURCE_DIR}/docs/doxygen/mainpage.dox"   )
   set(DOXYGEN_EXCLUDE          "${PROJECT_SOURCE_DIR}/dart/external"          )
   set(DOXYGEN_STRIP_FROM_PATH  "${CMAKE_CURRENT_SOURCE_DIR}"                  )
 
@@ -612,7 +612,7 @@ if(DOXYGEN_FOUND)
   # - DOXYGEN_STRIP_FROM_PATH
   configure_file(${DOXYGEN_DOXYFILE_IN} ${DOXYGEN_DOXYFILE} @ONLY)
   file(
-    COPY "${PROJECT_SOURCE_DIR}/doxygen/DART logo.png"
+    COPY "${PROJECT_SOURCE_DIR}/docs/doxygen/DART logo.png"
     DESTINATION ${DOXYGEN_OUTPUT_ROOT}
   )
   add_custom_command(

diff --git a/doxygen/DART logo.png → docs/doxygen/DART logo.png b/doxygen/DART logo.png → docs/doxygen/DART logo.png
diff --git a/doxygen/Doxyfile.in → docs/doxygen/Doxyfile.in b/doxygen/Doxyfile.in → docs/doxygen/Doxyfile.in
diff --git a/doxygen/mainpage.dox → docs/doxygen/mainpage.dox b/doxygen/mainpage.dox → docs/doxygen/mainpage.dox
diff --git a/scripts/build_docs.sh b/scripts/build_docs.sh
@@ -42,5 +42,16 @@ while read version; do
   cmake ${DART_CLONE_DIR}
   make docs
 
-  mv doxygen/html ${DART_DOCS_OUTPUT_DIR}/${version}
+  # Check if docs/doxygen/html is not empty
+  if [ "$(ls -A docs/doxygen/html 2>/dev/null)" ]; then
+    echo "Moving docs/doxygen/html..."
+    mv docs/doxygen/html "${DART_DOCS_OUTPUT_DIR}/${version}"
+  # Else, check if doxygen/html is not empty
+  elif [ "$(ls -A doxygen/html 2>/dev/null)" ]; then
+    echo "Moving doxygen/html..."
+    mv doxygen/html "${DART_DOCS_OUTPUT_DIR}/${version}"
+  else
+    echo "Both docs/doxygen/html and doxygen/html are empty. No files moved."
+  fi
+
 done <${DART_CLONE_DIR}/scripts/docs_versions.txt
diff --git a/setup.py b/setup.py
@@ -190,7 +190,7 @@ def build_extension(self, ext: CMakeExtension) -> None:
 sources.extend(glob("cmake/**/*", recursive=True))
 sources.extend(glob("dart/**/*", recursive=True))
 sources.extend(glob("python/**/*", recursive=True))
-sources.extend(glob("doxygen/**/*", recursive=True))
+sources.extend(glob("docs/doxygen/**/*", recursive=True))
 sources.extend(glob("examples/**/*", recursive=True))
 sources.extend(glob("scripts/**/*", recursive=True))
 sources.extend(glob("tutorials/**/*", recursive=True))