Merge branch 'ershi/add-doctest-to-build-docs' into 'main'

Run doctest as part of build_docs.py

See merge request omniverse/warp!952

.gitlab-ci.yml

@@ -449,7 +449,7 @@ windows-x86_64 docs:
     - python -m pip install -r docs/requirements.txt
     - Write-Output "$([char]27)[0Ksection_end:$(GetTime):install_dependencies$([char]13)$([char]27)[0K"
   script:
-    - python build_docs.py
+    - python build_docs.py --no_doctest
     - mv docs/_build/html/ ./public/
   after_script:
     - echo "View the website at https://$CI_PROJECT_ROOT_NAMESPACE.$CI_PAGES_DOMAIN/-/$CI_PROJECT_NAME/-/jobs/$CI_JOB_ID/artifacts/public/index.html"
@@ -730,7 +730,7 @@ publish wheels to gitlab package registry:
     - python -m pip install -r docs/requirements.txt
     - echo -e "\\e[0Ksection_end:`date +%s`:install_dependencies\\r\\e[0K"
   script:
-    - python build_docs.py
+    - python build_docs.py --no_doctest
     - mv docs/_build/html/ ./public/
 
 # Merge requests: Build documentation and save as an artifact

build_docs.py

@@ -5,12 +5,21 @@
 # distribution of this software and related documentation without an express
 # license agreement from NVIDIA CORPORATION is strictly prohibited.
 
+import argparse
 import os
 import shutil
 import subprocess
 
 from warp.context import export_functions_rst, export_stubs
 
+parser = argparse.ArgumentParser(description="Warp Sphinx Documentation Builder")
+# Note argparse.BooleanOptionalAction can be used here when Python 3.9+ becomes the minimum supported version
+parser.add_argument("--doctest", action="store_true", help="Also run doctest on code snippets, default enabled")
+parser.add_argument("--no_doctest", dest="doctest", action="store_false")
+parser.set_defaults(doctest=True)
+
+args = parser.parse_args()
+
 base_path = os.path.dirname(os.path.realpath(__file__))
 
 # generate stubs for autocomplete
@@ -34,4 +43,16 @@
 
 subprocess.run(command, check=True)
 
+if args.doctest:
+    print("Running doctest... (skip with --no_doctest)")
+
+    output_dir = os.path.join(base_path, "docs", "_build", "doctest")
+
+    if os.path.exists(output_dir):
+        shutil.rmtree(output_dir)
+
+    command = ["sphinx-build", "-W", "-b", "doctest", source_dir, output_dir]
+
+    subprocess.run(command, check=True)
+
 print("Finished")

docs/modules/tiles.rst

@@ -23,6 +23,7 @@ Inside kernels, tile operations are executed cooperatively across each block of
 In the following example, we launch a grid of threads where each block is responsible for loading a row of data from a 2D array and computing its sum:
 
 .. testcode::
+    :skipif: wp.get_cuda_device_count() == 0
 
     TILE_SIZE = wp.constant(256)
     TILE_THREADS = 64