docs: add sitemap and robots (#391)

Signed-off-by: Keming <kemingy94@gmail.com>
0b01001001 · Nov 25, 2024 · 95aff9d · 95aff9d
1 parent d0d4363
commit 95aff9d
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 1 deletion.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -34,6 +34,7 @@
     "sphinx.ext.autodoc",
     "sphinx.ext.githubpages",
     "myst_parser",
+    "sphinx_sitemap",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -45,7 +46,8 @@
 exclude_patterns = []
 source_suffix = [".rst", ".md"]
 language = "en"
-
+html_baseurl = "https://0b01001001.github.io/spectree/"
+html_extra_path = ['robots.txt']
 
 # -- Options for HTML output -------------------------------------------------
 

diff --git a/docs/source/robots.txt b/docs/source/robots.txt
@@ -0,0 +1,3 @@
+User-agent: *
+
+Sitemap: https://0b01001001.github.io/spectree/sitemap.xml
diff --git a/pyproject.toml b/pyproject.toml
@@ -54,6 +54,7 @@ docs = [
     "Sphinx",
     "shibuya",
     "myst-parser",
+    "sphinx-sitemap",
 ]
 
 [project.urls]

diff --git a/setup.py b/setup.py
@@ -23,6 +23,7 @@
             "Sphinx",
             "shibuya",
             "myst-parser",
+            "sphinx-sitemap",
         ],
     },
 )
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		User-agent: *

		Sitemap: https://0b01001001.github.io/spectree/sitemap.xml