Add sphinx-sitemap to generate sitemap

lanl · Sep 29, 2024 · 52334d4 · 52334d4
1 parent 5c84956
commit 52334d4
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 1 deletion.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -24,6 +24,7 @@ jobs:
         - name: install dependencies
           run: |
             pip install sphinx
+            pip install sphinx-sitemap
             pip install sphinx-rtd-theme
             pip install sphinx-multiversion
             pip install sphinx-copybutton

diff --git a/doc/sphinx/conf.py b/doc/sphinx/conf.py
@@ -16,7 +16,12 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ["sphinx_multiversion", "sphinx.ext.todo", "sphinx_copybutton"]
+extensions = [
+    "sphinx_multiversion",
+    "sphinx.ext.todo",
+    "sphinx_copybutton",
+    "sphinx_sitemap",
+]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
@@ -44,3 +49,6 @@
 
 # Display todos by setting to True
 todo_include_todos = True
+
+# baseurl for sitemap
+html_baseurl = "https://lanl.github.io/phoebus"
diff --git a/doc/sphinx/index.rst b/doc/sphinx/index.rst
@@ -31,3 +31,9 @@ Key Features
    :glob:
 
    src/*
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`search`