Added the sphinx-sitemap package to generate a xml sitemap to submit …

…to google search console.
neuroinformatics-unit · Oct 20, 2023 · 5a3f499 · 5a3f499
1 parent 4215c73
commit 5a3f499
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/{{cookiecutter.package_name}}/docs/requirements.txt b/{{cookiecutter.package_name}}/docs/requirements.txt
@@ -5,3 +5,4 @@ pydata-sphinx-theme
 setuptools-scm
 sphinx
 sphinx-autodoc-typehints
+sphinx-sitemap
diff --git a/{{cookiecutter.package_name}}/docs/source/conf.py b/{{cookiecutter.package_name}}/docs/source/conf.py
@@ -41,6 +41,7 @@
     "sphinx.ext.autosummary",
     "sphinx.ext.viewcode",
     "sphinx.ext.intersphinx",
+    "sphinx-sitemap",
     "myst_parser",
     "nbsphinx",
 ]
@@ -113,6 +114,7 @@
 # https://www.sphinx-doc.org/en/master/usage/extensions/githubpages.html
 github_user = "{{cookiecutter.github_username_or_organization}}"
 html_baseurl = f"https://{github_user}.github.io/{project}"
+sitemap_url_scheme = "{link}"
 
 # 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,