docs: add sitemap and robots (#603)

kemingy · web-flow · commit b708ca026ebd · 2024-11-26T03:56:10.000Z
Signed-off-by: Keming &lt;kemingy94@gmail.com&gt;
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -29,6 +29,7 @@
     "sphinxcontrib.programoutput",
     "sphinx_autodoc_typehints",
     "sphinxext.opengraph",
+    "sphinx_sitemap",
 ]
 
 templates_path = ["_templates"]
@@ -47,7 +48,9 @@
 # https://sphinxext-opengraph.readthedocs.io/en/latest/
 ogp_site_url = "https://mosecorg.github.io/mosec/"
 ogp_image = "https://user-images.githubusercontent.com/38581401/240117836-f06199ba-c80d-413a-9cb4-5adc76316bda.png"
-
+# https://sphinx-sitemap.readthedocs.io/en/latest/getting-started.html
+html_baseurl = "https://mosecorg.github.io/mosec/"
+html_extra_path = ['robots.txt']
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
diff --git a/docs/source/robots.txt b/docs/source/robots.txt
@@ -0,0 +1,3 @@
+User-agent: *
+
+Sitemap: https://mosecorg.github.io/mosec/sitemap.xml
diff --git a/requirements/doc.txt b/requirements/doc.txt
@@ -6,3 +6,4 @@ sphinx_autodoc_typehints>=1.22
 sphinxext-opengraph>=0.8
 myst-parser>=0.18
 furo>=2022.12.7
+sphinx-sitemap>=2.6.0

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+User-agent: *`
	`2`	`+`
	`3`	`+Sitemap: https://mosecorg.github.io/mosec/sitemap.xml`