Merge topic 'update-readthedocs-deps'

f6d513805 ci,docs: add user guide files to artifacts
d5a90cba1 update readthedocs-sphinx-search

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !3179

.gitlab-ci.yml

@@ -216,6 +216,10 @@ stages:
       # CDash files.
       - build/DartConfiguration.tcl
 
+      # Users guide
+      - build/docs/users-guide/html
+      - build/docs/users-guide/latex
+
 .cmake_test_artifacts: &cmake_test_artifacts
   artifacts:
     expire_in: 24 hours

.gitlab/ci/doxygen.yml

@@ -39,9 +39,10 @@ build:docs-continuous:
   script:
     - *build_doxygen_script
   extends:
+    - .build_docs
+    - .cmake_build_artifacts
     - .run_automatically
     - .ubuntu2004_doxygen
-    - .build_docs
 
 build:docs-master:
   script:
@@ -55,8 +56,9 @@ build:docs-master:
       when: on_success
     - when: never
   extends:
-    - .ubuntu2004_doxygen
     - .build_docs
+    - .cmake_build_artifacts
+    - .ubuntu2004_doxygen
   variables:
     DOXYGEN_UPLOAD_REMOTE_PATH: "nightly"
 
@@ -72,7 +74,8 @@ build:docs-latest:
       when: on_success
     - when: never
   extends:
-    - .ubuntu2004_doxygen
     - .build_docs
+    - .cmake_build_artifacts
+    - .ubuntu2004_doxygen
   variables:
     DOXYGEN_UPLOAD_REMOTE_PATH: "latest"

.readthedocs.yaml

@@ -36,7 +36,7 @@ sphinx:
 
 python:
   install:
-  - requirements: docs/requirements.txt
+  - requirements: docs/users-guide/requirements.txt
 
 formats:
 - epub

CMake/VTKmCheckCopyright.cmake

@@ -36,7 +36,7 @@ set(FILES_TO_CHECK
 set(EXCEPTIONS
   LICENSE.txt
   README.txt
-  docs/requirements.txt
+  docs/users-guide/requirements.txt
   )
 
 if (NOT VTKm_SOURCE_DIR)

docs/users-guide/requirements.in

@@ -3,5 +3,4 @@ Sphinx==7.2.6
 sphinx-rtd-theme==1.3.0
 sphinxcontrib-moderncmakedomain==3.27.0
 sphinxcontrib-packages==1.1.2
-readthedocs-sphinx-search
-extract_examples
+readthedocs-sphinx-search==0.3.2

docs/users-guide/requirements.txt

@@ -2,14 +2,14 @@
 # This file is autogenerated by pip-compile with Python 3.10
 # by the following command:
 #
-#    pip-compile docs/requirements.in
+#    pip-compile requirements.in
 #
 alabaster==0.7.13
     # via sphinx
 babel==2.13.0
     # via sphinx
 breathe==4.35.0
-    # via -r docs/requirements.in
+    # via -r requirements.in
 certifi==2023.7.22
     # via requests
 charset-normalizer==3.3.0
@@ -33,15 +33,15 @@ packaging==23.2
     # via sphinx
 pygments==2.16.1
     # via sphinx
-readthedocs-sphinx-search==0.3.1
-    # via -r docs/requirements.in
+readthedocs-sphinx-search==0.3.2
+    # via -r requirements.in
 requests==2.31.0
     # via sphinx
 snowballstemmer==2.2.0
     # via sphinx
 sphinx==7.2.6
     # via
-    #   -r docs/requirements.in
+    #   -r requirements.in
     #   breathe
     #   sphinx-rtd-theme
     #   sphinxcontrib-applehelp
@@ -53,7 +53,7 @@ sphinx==7.2.6
     #   sphinxcontrib-qthelp
     #   sphinxcontrib-serializinghtml
 sphinx-rtd-theme==1.3.0
-    # via -r docs/requirements.in
+    # via -r requirements.in
 sphinxcontrib-applehelp==1.0.7
     # via sphinx
 sphinxcontrib-devhelp==1.0.5
@@ -65,9 +65,9 @@ sphinxcontrib-jquery==4.1
 sphinxcontrib-jsmath==1.0.1
     # via sphinx
 sphinxcontrib-moderncmakedomain==3.27.0
-    # via -r docs/requirements.in
+    # via -r requirements.in
 sphinxcontrib-packages==1.1.2
-    # via -r docs/requirements.in
+    # via -r requirements.in
 sphinxcontrib-qthelp==1.0.6
     # via sphinx
 sphinxcontrib-serializinghtml==1.1.9