SEO: increase site visibility

jonas-rem · jonas-rem · commit 84fa3339cb94 · 2024-10-31T18:23:26.000+01:00
Increase site visibility by providing a robots.txt file that points to a
generated page sitemap.

In addition this commit adds a verification code to be able to analyze
it via Google Search Console. This does not track users or collect data,
but only analyzes how well the page can be indext and found.

Signed-off-by: Jonas Remmert &lt;jremmert@gmx.net&gt;
diff --git a/doc/requirements.txt b/doc/requirements.txt
@@ -7,3 +7,4 @@ sphinxcontrib-redoc
 sphinx-autobuild
 codespell
 tox
+sphinx-sitemap==2.6.0
diff --git a/doc/source/_static/google70331152569d412b.html b/doc/source/_static/google70331152569d412b.html
@@ -0,0 +1 @@
+google-site-verification: google70331152569d412b.html
diff --git a/doc/source/_static/robots.txt b/doc/source/_static/robots.txt
@@ -0,0 +1,3 @@
+User-agent: *
+
+Sitemap: https://flownexus-lwm2m.github.io/flownexus/sitemap.xml
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -32,13 +32,21 @@
     'sphinx.ext.imgconverter',
     'sphinx.ext.todo',
     'sphinxcontrib.redoc',
+    'sphinx_sitemap',
 ]
 
 exclude_patterns = []
 
 html_theme = 'sphinx_book_theme'
 html_static_path = ['_static']
 html_favicon = '_static/flownexus_favicon.svg'
+html_baseurl = 'https://flownexus-lwm2m.github.io/flownexus/'
+
+sitemap_url_scheme = "{link}"
+sitemap_locales = [None]
+# Add robots.txt so search engines can index the site
+html_extra_path = ['_static/robots.txt',
+                   '_static/google70331152569d412b.html']
 
 # Single gray logo for both dark and light themes (not used)
 # html_logo = '_static/flownexus_logo_gray.svg'

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+google-site-verification: google70331152569d412b.html`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+User-agent: *`
	`2`	`+`
	`3`	`+Sitemap: https://flownexus-lwm2m.github.io/flownexus/sitemap.xml`