docs: 📚 add sitemap

noshita · Aug 18, 2023 · 8ea64cf · 8ea64cf
1 parent 785d6c7
commit 8ea64cf
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 5 deletions.
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -26,7 +26,7 @@ jobs:
       - name: Install dependencies
         run: |
             python -m pip install --upgrade pip
-            pip install sphinx pydata-sphinx-theme sphinx-autobuild sphinx-gallery sphinxcontrib-bibtex myst-nb nbsphinx  numpydoc matplotlib seaborn
+            pip install sphinx pydata-sphinx-theme sphinx-autobuild sphinx-gallery sphinxcontrib-bibtex myst-nb nbsphinx  numpydoc matplotlib seaborn sphinx-sitemap
             if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
             pip install -e .
       - name: Sphinx build

diff --git a/doc/conf.py b/doc/conf.py
@@ -45,11 +45,8 @@
     "sphinx.ext.viewcode",
     "sphinx.ext.mathjax",
     "numpydoc",
-    # "sphinx_gallery.gen_gallery",
-    # "notfound.extension",
-    # "nbsphinx",
-    # "sphinx_gallery.load_style",
     "myst_nb",
+    "sphinx_sitemap",
 ]
 
 # this is needed for some reason...
@@ -179,6 +176,7 @@
     # "external_links": [
     #     {"name": "Learn", "url": "https://numpy.org/numpy-tutorials/"}
     #     ],
+    "analytics": {"google_analytics_id": "G-6WZ5SLD7H7"},
 }
 
 # Add any paths that contain custom themes here, relative to this directory.
@@ -255,6 +253,10 @@
 # Output file base name for HTML help builder.
 htmlhelp_basename = "ktchdoc"
 
+# sphinx-sitemap
+html_baseurl = "https://doc.ktch.dev/"
+sitemap_locales = [None]
+sitemap_url_scheme = "{link}"
 
 # -- Options for LaTeX output ---------------------------------------------
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -71,6 +71,7 @@ sphinx = "^5.3"
 sphinx-autobuild = "^2021.3"
 sphinx-gallery = "^0.11"
 sphinxcontrib-bibtex = "^2.5"
+sphinx-sitemap = "^2.5.0"
 
 [build-system]
 build-backend = "poetry.core.masonry.api"