Add a condition for tutorials

Author: svekars

.gitignore

@@ -12,3 +12,4 @@ dist/
 scss/vendor/*
 *.pyc
 docs/auto_examples/*
+docs/sg_execution_times.rst

docs/conf.py

@@ -4,7 +4,7 @@
 sys.path.insert(0, os.path.abspath(".."))
 
 import pytorch_sphinx_theme2
-import torch
+# import torch  # Temporarily commented out for testing
 
 html_theme = "pytorch_sphinx_theme2"
 html_theme_path = [pytorch_sphinx_theme2.get_html_theme_path()]
@@ -41,12 +41,15 @@
 sphinx_gallery_conf = {
     "examples_dirs": "examples",  # path to your example scripts
     "gallery_dirs": "auto_examples",  # where to save gallery generated output
-    "filename_pattern": "/example_",  # Only run files that match this pattern
+    "filename_pattern": "/(example_|template_)",  # Process files starting with example_ or template_
     "plot_gallery": True,  # Generate plots for examples
+    "promote_jupyter_magic": True,
+    "first_notebook_cell": ("%matplotlib inline"),
 }
 
 # pytorch_project = "tutorials"
-torch_version = str(torch.__version__)
+# torch_version = str(torch.__version__)  # Temporarily commented out for testing
+torch_version = "2.0.0"  # Hardcoded for testing
 version = "main (" + torch_version + " )"
 # The full version, including alpha/beta/rc tags.
 release = "main"
@@ -58,7 +61,7 @@
     # Note: the release candidates should no longer have the aHASH suffix, but in any
     # case we wish to leave only major.minor, even for rc builds.
     version = ".".join(torch_version.split(".")[:2])
-    html_title = " ".join((project, version, "documentation"))
+    html_title = " ".join(("PyTorch Sphinx Theme2", version, "documentation"))
     release = version
 
 # Do not warn about external images (status badges in README.rst)
@@ -105,6 +108,26 @@
 
 html_title = " ".join((project, version, "documentation"))
 
+# Tutorial repository configuration using existing html_context variables
+theme_variables = pytorch_sphinx_theme2.get_theme_variables()
+html_context = {
+    "theme_variables": theme_variables,
+    "library_links": theme_variables.get("library_links", []),
+    "feedback_url": "https://github.com/pytorch/pytorch_sphinx_theme",
+    "github_url": "https://github.com",
+    "github_user": "pytorch",
+    "github_repo": "tutorials",     # Changed to tutorials for tutorial buttons
+    "github_version": "main",       # Changed to main branch for tutorials
+    "colab_branch": "gh-pages",     # New variable for Colab branch
+    "doc_path": "docs",
+    "extra_project_links": theme_variables.get("extra_project_links", []),
+    "date_info": {
+        "paths_to_skip": ["installing"],
+    },
+    "version": version,
+    "has_sphinx_gallery": True,
+}
+
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
 # today = ''
@@ -201,25 +224,10 @@
     # },
     # "canonical_url": "https://pytorch.org/docs/stable/",
     "canonical_url": "http://localhost:8000",
-    "pytorch_project": "tutorials",
-}
+    #"pytorch_project": "tutorials",
+  }
+
 
-theme_variables = pytorch_sphinx_theme2.get_theme_variables()
-html_context = {
-    "theme_variables": theme_variables,
-    "library_links": theme_variables.get("library_links", []),
-    "feedback_url": "https://github.com/pytorch/pytorch_sphinx_theme",
-    "github_url": "https://github.com",
-    "github_user": "pytorch",
-    "github_repo": "pytorch_sphinx_theme",
-    "github_version": "master",
-    "doc_path": "docs",
-    "extra_project_links": theme_variables.get("extra_project_links", []),
-    "date_info": {
-        "paths_to_skip": ["installing"],
-    },
-    "version": version,
-}
 # Add any paths that contain custom themes here, relative to this directory.
 html_theme_path = ["../"]
 

docs/sg_execution_times.rst

@@ -7,7 +7,22 @@ document.addEventListener('DOMContentLoaded', function() {
       var tutorialUrlArray = $("#tutorial-type").text().split('/');
       tutorialUrlArray[0] = tutorialUrlArray[0] + "_source"
 
-      var githubLink = "https://github.com/pytorch/tutorials/blob/main/" + tutorialUrlArray.join("/") + ".py";
+      // Get configurable repository settings from conf.py
+
+      // Default to PyTorch tutorials for backward compatibility
+      var defaultGithubRepo = "pytorch/tutorials";
+      var defaultGithubBranch = "main";
+      var defaultColabRepo = "pytorch/tutorials";
+      var defaultColabBranch = "gh-pages";
+
+      // Use configured values from window.repoConfig or fallback to defaults
+      // This ensures backward compatibility when tutorial_repo_config is not defined
+      var githubRepo = (window.repoConfig && window.repoConfig.github_repo) || defaultGithubRepo;
+      var githubBranch = (window.repoConfig && window.repoConfig.github_branch) || defaultGithubBranch;
+      var colabRepo = (window.repoConfig && window.repoConfig.colab_repo) || defaultColabRepo;
+      var colabBranch = (window.repoConfig && window.repoConfig.colab_branch) || defaultColabBranch;
+
+      var githubLink = "https://github.com/" + githubRepo + "/blob/" + githubBranch + "/" + tutorialUrlArray.join("/") + ".py";
 
       // Find the notebook download link by checking for .ipynb extension
       var notebookLinks = $(".reference.download");
@@ -24,11 +39,11 @@ document.addEventListener('DOMContentLoaded', function() {
       }
 
       var notebookDownloadPath = notebookLink.split('_downloads')[1],
-          colabLink = "https://colab.research.google.com/github/pytorch/tutorials/blob/gh-pages/_downloads" + notebookDownloadPath;
+          colabLink = "https://colab.research.google.com/github/" + colabRepo + "/blob/" + colabBranch + "/_downloads" + notebookDownloadPath;
 
-      $("#google-colab-link").wrap("<a href=" + colabLink + " data-behavior='call-to-action-event' data-response='Run in Google Colab' target='_blank'/>");
-      $("#download-notebook-link").wrap("<a href=" + notebookLink + " data-behavior='call-to-action-event' data-response='Download Notebook'/>");
-      $("#github-view-link").wrap("<a href=" + githubLink + " data-behavior='call-to-action-event' data-response='View on Github' target='_blank'/>");
+      $("#colab-link").attr("href", colabLink);
+      $("#notebook-link").attr("href", notebookLink);
+      $("#github-link").attr("href", githubLink);
 
       // Hide the original download links and signature
       $(".sphx-glr-footer").hide();

pytorch_sphinx_theme2/static/js/theme.js

@@ -29,34 +29,21 @@
   });
 </script>
 <!-- Conditional CSS for header and footer height adjustment -->
-{% if not theme_show_lf_header or not theme_show_lf_footer %}
+{% if not theme_show_lf_header %}
 <style>
-  {
-    % if not theme_show_lf_header %
-  }
-
   :root {
     --header-height: 0px !important;
     --header-height-desktop: 0px !important;
   }
-
-    {
-    % endif %
-  }
-
-    {
-    % if not theme_show_lf_footer %
-  }
-
+</style>
+{% endif %}
+{% if not theme_show_lf_footer %}
+<style>
   @media (min-width: 1100px) {
     .site-footer {
       height: 300px !important;
     }
   }
-
-    {
-    % endif %
-  }
 </style>
 {% endif %}
 <link rel="stylesheet" type="text/css" href="{{ pathto('_static/css/theme.css', 1) }}" crossorigin="anonymous">
@@ -68,7 +55,7 @@
 <link rel="stylesheet" href="{{ pathto('_static/webfonts/all.min.css', 1) }}" crossorigin="anonymous">
 <meta http-equiv="Content-Security-Policy"
   content="default-src * 'unsafe-inline' 'unsafe-eval' data: blob:; style-src * 'unsafe-inline'; script-src * 'unsafe-inline' 'unsafe-eval' blob:;">
-<meta name="pytorch_project" content="{{ pytorch_project }}">
+<meta name="pytorch_project" content="{{ theme_pytorch_project }}">
 <!-- Google Tag Manager (noscript) -->
 <noscript><iframe src="https://www.googletagmanager.com/ns.html?id={{ theme_analytics_id }}" height="0" width="0"
     style="display:none;visibility:hidden"></iframe></noscript>
@@ -116,6 +103,20 @@
   }
 </script>
 <!-- End Facebook Pixel Code -->
+<!-- Repository configuration for tutorials -->
+{% if (theme_pytorch_project == 'tutorials' or has_sphinx_gallery) and github_user and github_repo %}
+<script>
+  // Define repository configuration for tutorial buttons using existing html_context variables
+  // Only injected when tutorial buttons are shown AND github variables are defined
+  // If either condition is false, JavaScript will fallback to default PyTorch tutorial links
+  window.repoConfig = {
+    github_repo: "{{ github_user }}/{{ github_repo }}",
+    github_branch: "{{ github_version }}",
+    colab_repo: "{{ github_user }}/{{ github_repo }}",
+    colab_branch: "{{ colab_branch }}"
+  };
+</script>
+{% endif %}
 <!-- Script to Fix scrolling -->
 <script>
   document.addEventListener('DOMContentLoaded', function () {

pytorch_sphinx_theme2/static/js/tutorial-buttons-call-to-action.js

@@ -279,6 +279,30 @@ If your site includes tutorials generated by sphinx-gallery, note that pytorch_s
 No additional configuration is needed for tutorial functionality that was previously handled through custom overrides.
 `custom_directives.py` along with various overrides in layout.html can be safely removed.
 
+### Confgiuring Download links
+
+The PyTorch Sphinx Theme 2 supports configurable tutorial repository
+links for the call-to-action buttons (GitHub, Colab, Download). This
+allows different projects to customize the repository links while
+maintaining backward compatibility.
+
+
+Define the repository configuration in your `conf.py`:
+
+```python
+# Tutorial repository configuration
+
+```
+html_context = {
+    "github_repo": "your-org/your-repo",
+    "github_branch": "main",
+    "colab_repo": "your-org/your-colab-repo",
+    "colab_branch": "gh-pages"
+}
+```
+
+The `layout.html` template automatically injects the configuration as JavaScript:
+
 ## Using `sphinx.ext.linkcode`
 
 We highly recommend that you configure `sphinx.ext.linkcode` on your site if you generate Python API