Added sitemap.xml

Koen1999 · Jan 19, 2025 · e61cf33 · e61cf33
1 parent bc5bd67
commit e61cf33
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 0 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -30,6 +30,7 @@
     "sphinx.ext.intersphinx",
     "sphinx.ext.viewcode",
     "sphinx_click",
+    "sphinx_sitemap",
 ]
 
 templates_path = ["_templates"]
@@ -81,3 +82,15 @@
 # https://www.sphinx-doc.org/en/master/usage/extensions/viewcode.html
 
 viewcode_line_numbers = True
+
+# -- Options for sphinx-sitemap    -------------------------------------------------
+# https://sphinx-sitemap.readthedocs.io/en/latest/index.html
+
+html_baseurl = "https://suricata-check.teuwen.net/"
+sitemap_url_scheme = "{link}"
+sitemap_locales = ['en']
+sitemap_excludes = [
+    "search.html",
+    "genindex.html"
+]
+html_extra_path = ['robots.txt']
diff --git a/docs/robots.txt b/docs/robots.txt
@@ -0,0 +1,3 @@
+User-agent: *
+
+Sitemap: https://suricata-check.teuwen.net/sitemap.xml
diff --git a/pyproject.toml b/pyproject.toml
@@ -71,6 +71,7 @@ dev = [
   "myst-parser[linkify]>=3.0.1",
   "sphinx-click>=6.0.0",
   "sphinx-autoapi>=3.4.0",
+  "sphinx-sitemap>=2.6.0",
 ]
 
 [project.urls]

diff --git a/requirements.txt b/requirements.txt
@@ -16,6 +16,7 @@ sphinx-rtd-theme>=3.0.0
 myst-parser[linkify]>=3.0.1
 sphinx-click>=6.0.0
 sphinx-autoapi>=3.4.0
+sphinx-sitemap>=2.6.0
 numpy>=1.26.4
 pandas>=2.0.3
 scikit-learn==1.5.1
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		User-agent: *

		Sitemap: https://suricata-check.teuwen.net/sitemap.xml