doc: Suppress doc warnings about duplicate labels (#7889)

GenericMappingTools · Oct 9, 2023 · 08dc64b · 08dc64b
1 parent 0ead8b5
commit 08dc64b
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -140,6 +140,9 @@ jobs:
           # if html.log isn't empty (i.e., sphinx raise warnings), return 1
           ! [ -s doc/rst/html.log ]
           cmake --build . --target docs_man
+          # Show warnings saved in html.log and man.log but filter out "duplicate label" warnings.
+          # See https://github.com/GenericMappingTools/gmt/issues/7253
+          grep -v 'WARNING: duplicate label -' doc/rst/html.log
 
       - name: Install GMT
         run: |

diff --git a/doc/rst/CMakeLists.txt b/doc/rst/CMakeLists.txt
@@ -66,9 +66,9 @@ if (SPHINX_FOUND)
 		COMMAND ${SPHINX_EXECUTABLE} -q -b html
 		-c "${CMAKE_CURRENT_BINARY_DIR}"
 		-d "${CMAKE_CURRENT_BINARY_DIR}/_doctrees_html"
-		-w "${CMAKE_CURRENT_BINARY_DIR}/html.log"
 		${CMAKE_CURRENT_BINARY_DIR}/source
 		${CMAKE_CURRENT_BINARY_DIR}/html
+		2> "${CMAKE_CURRENT_BINARY_DIR}/html.log"
 		COMMENT "Building HTML documentation...")
 	add_dependencies (docs_html docs_depends)
 
@@ -78,10 +78,10 @@ if (SPHINX_FOUND)
 			COMMAND ${SPHINX_EXECUTABLE} -q -b man
 			-c "${CMAKE_CURRENT_BINARY_DIR}"
 			-d "${CMAKE_CURRENT_BINARY_DIR}/_doctrees_man"
-			-w "${CMAKE_CURRENT_BINARY_DIR}/man.log"
 			-t nosphinxpanels
 			${CMAKE_CURRENT_BINARY_DIR}/source
 			${CMAKE_CURRENT_BINARY_DIR}/man
+			2> "${CMAKE_CURRENT_BINARY_DIR}/man.log"
 			COMMAND ${GZIP} -9 -n -f ${CMAKE_CURRENT_BINARY_DIR}/man/*.?
 			COMMENT "Building manpages...")
 		add_dependencies (docs_man docs_depends)