Merge topic 'user-guide-todos'

39aa256bb docs: edit .readthedocs.yaml
b261d2387 Allow turning off todo notes in user's guide

Acked-by: Kitware Robot <kwrobot@kitware.com>
Acked-by: Kenneth Moreland <morelandkd@ornl.gov>
Acked-by: Vicente Bolea <vicente.bolea@kitware.com>
Merge-request: !3145

.gitlab/ci/config/initial_config.cmake

@@ -66,6 +66,7 @@ foreach(option IN LISTS options)
 
   elseif(docs STREQUAL option)
     set(VTKm_ENABLE_DOCUMENTATION "ON" CACHE STRING "")
+    set(VTKm_USERS_GUIDE_INCLUDE_TODOS "OFF" CACHE STRING "")
 
   elseif(benchmarks STREQUAL option)
     set(VTKm_ENABLE_BENCHMARKS "ON" CACHE STRING "")

.readthedocs.yaml

@@ -27,7 +27,7 @@ build:
     - git lfs install --local
     - git lfs fetch --include "*.png"
     - git lfs checkout *.png
-    - cmake -B build -S . -DVTKm_ENABLE_DOCUMENTATION=ON -DVTKm_ENABLE_USERS_GUIDE=ON
+    - cmake -B build -S . -DVTKm_ENABLE_DOCUMENTATION=ON -DVTKm_ENABLE_USERS_GUIDE=ON -DVTKm_USERS_GUIDE_INCLUDE_TODOS=OFF
     - cmake --build build --target VTKmDoxygenDocs
     - cp -f ./build/docs/users-guide/VTKmUsersGuideHTML.cache/conf.py docs/users-guide/conf.py
 

docs/users-guide/CMakeLists.txt

@@ -25,9 +25,18 @@ if (NOT Sphinx_FOUND)
     "Could not find Sphinx to build User's Guide. If you want to compile Doxygen without the User's Guide, turn off VTKm_ENABLE_USERS_GUIDE.")
 endif()
 
+option(VTKm_USERS_GUIDE_INCLUDE_TODOS
+  "When building the VTK-m User's Guide, specify whether to include TODO notes." ON)
+mark_as_advanced(VTKm_USERS_GUIDE_INCLUDE_TODOS)
+
 # Configuration used in conf.py.
 set(doxygen_xml_output_dir "${VTKm_BINARY_DIR}/docs/doxygen/xml")
 set(example_directory "${CMAKE_CURRENT_SOURCE_DIR}/examples")
+if(VTKm_USERS_GUIDE_INCLUDE_TODOS)
+  set(include_todos "True")
+else()
+  set(include_todos "False")
+endif()
 
 sphinx_add_docs(VTKmUsersGuideHTML
   BUILDER html

docs/users-guide/conf.py

@@ -52,7 +52,7 @@ extensions = [
 ]
 # Note: there are some custom extensions at the bottom of this file.
 
-todo_include_todos = True
+todo_include_todos = @include_todos@
 
 numfig = True
 autosectionlabel_prefix_document = True

docs/users-guide/index.rst

@@ -4,8 +4,6 @@
 The VTK-m User's Guide
 ==============================
 
-.. todo:: Hide TODOs for release documentation.
-
 | **The VTK-m User's Guide**
 | Version |version|