Add sitemap (#3035)

svekars · web-flow · commit f1380d39af94 · 2024-09-10T09:00:41.000-07:00
* Add sitemap
* Remove PyTorch sphinx theme as submodule
* Exclude src/pytorch_sphinx_theme/docs from the build so that the html pages under don't appear on the site and in the sitemap
diff --git a/.ci/docker/requirements.txt b/.ci/docker/requirements.txt
@@ -6,6 +6,7 @@ sphinx-gallery==0.11.1
 sphinx_design
 docutils==0.16
 sphinx-copybutton
+sphinx_sitemap==2.6.0
 pypandoc==1.12
 pandocfilters
 markdown
diff --git a/.gitmodules b/.gitmodules
@@ -1 +0,0 @@
-
diff --git a/conf.py b/conf.py
@@ -82,6 +82,7 @@
     'sphinx_copybutton',
     'sphinx_gallery.gen_gallery',
     'sphinx_design',
+    'sphinx_sitemap'
 ]
 
 intersphinx_mapping = {
@@ -120,6 +121,14 @@ def reset_seeds(gallery_conf, fname):
     },
 }
 
+html_baseurl = 'https://pytorch.org/tutorials/' # needed for sphinx-sitemap
+sitemap_locales = [None]
+sitemap_excludes = [
+    "search.html",
+    "genindex.html",
+]
+sitemap_url_scheme = "{link}"
+
 if os.getenv('GALLERY_PATTERN'):
     # GALLERY_PATTERN is to be used when you want to work on a single
     # tutorial.  Previously this was fed into filename_pattern, but
@@ -182,7 +191,7 @@ def reset_seeds(gallery_conf, fname):
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'src/pytorch-sphinx-theme/docs*']
 exclude_patterns += sphinx_gallery_conf['examples_dirs']
 exclude_patterns += ['*/index.rst']
 
