docs: Add sitemap generation

Author: tdgroot

docs/conf.py

@@ -72,8 +72,12 @@
 }
 html_show_sphinx = False
 html_show_sourcelink = False
+
+sitemap_url_scheme = "{link}"
+
 if os.getenv("DOCS_BASE_URL"):
     html_baseurl = os.getenv("DOCS_BASE_URL")
+    extensions.append("sphinx_sitemap")  # Only generate sitemap when we have a base url
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

requirements/base.txt

@@ -8,6 +8,7 @@ mdformat==0.7.16
 mdformat-myst==0.1.5
 mdformat-frontmatter==0.4.1
 sphinx-notfound-page==0.8.3
+sphinx-sitemap==2.4.0
 
 # hypernode/ requirements
 beautifulsoup4==4.11.1