tc

Author: clee2000

.ci/docker/requirements.txt

@@ -2,7 +2,7 @@
 # Refer to ./jenkins/build.sh for tutorial build instructions
 
 sphinx==5.0.0
-sphinx-gallery==0.19.0
+sphinx-gallery==0.11.1
 sphinx_design
 docutils==0.16
 sphinx-copybutton

.jenkins/build.sh

@@ -58,7 +58,10 @@ if [[ "${JOB_TYPE}" == "worker" ]]; then
 
   # Step 3: Run `make docs` to generate HTML files and static files for these tutorialis
   pip3 install -e git+https://github.com/pytorch/pytorch_sphinx_theme.git#egg=pytorch_sphinx_theme
-  make docs
+  make download
+	make download-last-reviewed-json
+  python .jenkins/sphinx_files.py
+  make postprocess
 
   # Step 3.1: Run the post-processing script:
   python .jenkins/post_process_notebooks.py

.jenkins/sphinx_files.py

@@ -0,0 +1,13 @@
+import subprocess
+import os
+
+def main() -> None:
+    files_to_run = os.environ["FILES_TO_RUN"]
+    env = os.environ.copy()
+    for file in files_to_run.split(" "):
+        print(f"Running {file}")
+        env["RUNTHIS"] = file
+        subprocess.check_output(["make", "html"], env=env)
+
+if __name__ == "__main__":
+    main()

Makefile

@@ -90,16 +90,20 @@ download-last-reviewed-json:
 	@echo "Downloading tutorials-review-data.json..."
 	curl -o tutorials-review-data.json https://raw.githubusercontent.com/pytorch/tutorials/refs/heads/last-reviewed-data-json/tutorials-review-data.json
 	@echo "Finished downloading tutorials-review-data.json."
-docs:
-	make download
-	make download-last-reviewed-json
-	make html
+
+postprocess:
 	@python .jenkins/insert_last_verified.py $(BUILDDIR)/html
 	rm -rf docs
 	cp -r $(BUILDDIR)/html docs
 	touch docs/.nojekyll
 	rm -rf tutorials-review-data.json
 
+docs:
+	make download
+	make download-last-reviewed-json
+	make html
+	make postprocess
+
 html-noplot:
 	$(SPHINXBUILD) -D plot_gallery=0 -b html $(SPHINXOPTS) "$(SOURCEDIR)" "$(BUILDDIR)/html"
 	# bash .jenkins/remove_invisible_code_block_batch.sh "$(BUILDDIR)/html"

conf.py

@@ -48,35 +48,6 @@
 from pathlib import Path
 pio.renderers.default = 'sphinx_gallery'
 
-import sphinx_gallery.gen_rst
-import multiprocessing
-
-# Save the original function
-def isolated_call(func, args, kwargs, result_queue):
-    try:
-        result = func(*args, **kwargs)
-        result_queue.put((True, result))
-    except Exception as e:
-        result_queue.put((False, str(e)))
-
-def make_isolated_version(func):
-    def wrapper(*args, **kwargs):
-        result_queue = multiprocessing.Queue()
-        p = multiprocessing.Process(
-            target=isolated_call,
-            args=(func, args, kwargs, result_queue)
-        )
-        p.start()
-        p.join()
-        success, result = result_queue.get()
-        if success:
-            return result
-        else:
-            raise RuntimeError(f"Error in isolated process: {result}")
-    return wrapper
-
-# Monkey-patch
-sphinx_gallery.gen_rst.generate_file_rst = make_isolated_version(sphinx_gallery.gen_rst.generate_file_rst)
 
 try:
     import torchvision
@@ -133,7 +104,7 @@ def reset_seeds(gallery_conf, fname):
     'examples_dirs': ['beginner_source', 'intermediate_source',
                       'advanced_source', 'recipes_source', 'prototype_source'],
     'gallery_dirs': ['beginner', 'intermediate', 'advanced', 'recipes', 'prototype'],
-    'filename_pattern': re.compile(SPHINX_SHOULD_RUN),
+    'filename_pattern': os.getenv("RUNTHIS"),
     'promote_jupyter_magic': True,
     'backreferences_dir': None,
     'first_notebook_cell': ("# For tips on running notebooks in Google Colab, see\n"

custom_directives.py

@@ -88,7 +88,7 @@ def run(self):
             if 'intro' in self.options:
                 intro = self.options['intro'][:195] + '...'
             else:
-                _, blocks = sphinx_gallery.py_source_parser.split_code_and_text_blocks(abs_fname)
+                _, blocks = sphinx_gallery.gen_rst.split_code_and_text_blocks(abs_fname)
                 intro, _ = sphinx_gallery.gen_rst.extract_intro_and_title(abs_fname, blocks[0][1])
 
             thumbnail_rst = ''