chore: add sitemap for docs

authlib · Apr 14, 2024 · 2470d72 · 2470d72
1 parent 347cc2e
commit 2470d72
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -56,4 +56,5 @@ __pypackages__/
 
 public/en
 public/zh
+public/sitemap.xml
 demo.py
diff --git a/docs/conf.py b/docs/conf.py
@@ -25,6 +25,7 @@
     "sphinx.ext.extlinks",
     "sphinx_copybutton",
     "sphinx_design",
+    "sphinx_sitemap",
 ]
 
 extlinks = {
@@ -83,11 +84,21 @@
     "source_docs_path": "/docs/",
 }
 
+# sitemap configuration
+site_url = "https://jose.authlib.org/"
+sitemap_url_scheme = "{lang}{link}"
+sitemap_filename = "../sitemap.xml"
+sitemap_locales = []
+
 
 def setup(app):
-    global language, html_baseurl
+    global language, html_baseurl, sitemap_filename, sitemap_locales
 
     language = app.config.language
+    if language != 'en':
+        sitemap_filename = 'sitemap.xml'
+        sitemap_locales = [None]
+
     html_baseurl = f"https://jose.authlib.org/{language}/"
     html_context["languages"] = [
         ("English", f"https://jose.authlib.org/en/%s/", "en"),

diff --git a/public/robots.txt b/public/robots.txt
@@ -0,0 +1,3 @@
+User-agent: *
+
+Sitemap: https://jose.authlib.org/sitemap.xml
diff --git a/requirements/docs.txt b/requirements/docs.txt
@@ -1,4 +1,5 @@
 Sphinx
 sphinx-design
 sphinx-copybutton
+sphinx-sitemap
 shibuya
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		User-agent: *

		Sitemap: https://jose.authlib.org/sitemap.xml