Mechanism for skipping documentation in particular directories

CMB-S4 · Oct 23, 2024 · 12731e0 · 12731e0
1 parent 3446939
commit 12731e0
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/cmake/gen_per_module_docs.cmake b/cmake/gen_per_module_docs.cmake
@@ -5,6 +5,11 @@ file(GLOB cmake_projects RELATIVE ${CMAKE_BINARY_DIR} ${CMAKE_SOURCE_DIR}/*/CMak
 foreach(d ${cmake_projects})
 	get_filename_component(proj ${d} PATH)
 	get_filename_component(pname ${proj} NAME_WE)
+	# Skip any excluded projects
+	if(EXISTS "${CMAKE_SOURCE_DIR}/${pname}/.nodocs")
+		file(REMOVE "${CMAKE_SOURCE_DIR}/doc/moddoc_${pname}.rst")
+		continue()
+	endif()
 	# Copy header if exists, or create empty rst
 	if(EXISTS "${CMAKE_SOURCE_DIR}/${pname}/README.rst")
 		file(READ "${CMAKE_SOURCE_DIR}/${pname}/README.rst" MOD_HEADER)

diff --git a/examples/.nodocs b/examples/.nodocs