docs: add a sitemap

CHANGES.rst

@@ -3,6 +3,11 @@ All notable changes to this project will be documented in this file.
 The format is based on `Keep a Changelog <https://keepachangelog.com/en/1.0.0/>`_,
 and this project adheres to `Semantic Versioning <https://semver.org/spec/v2.0.0.html>`_.
 
+Added
+*****
+
+- Sitemap to the documentation :pr:`169`
+
 Changed
 *******
 

doc/conf.py

@@ -34,6 +34,7 @@ extensions = [
     "sphinx.ext.todo",
     "sphinx.ext.viewcode",
     "sphinx_issues",
+    "sphinx_sitemap",
 ]
 
 templates_path = ["_templates"]
@@ -44,8 +45,7 @@ year = datetime.datetime.now().strftime("%Y")
 copyright = f"{year}, Yaal Coop"
 author = "Yaal Coop"
 
-release = metadata.version("canaille")
-version = "%s.%s" % tuple(map(int, release.split(".")[:2]))
+version = metadata.version("canaille")
 language = "en"
 exclude_patterns = []
 pygments_style = "sphinx"
@@ -67,6 +67,7 @@ issues_commit_uri = "https://gitlab.com/yaal/canaille/-/commit/{commit}"
 
 html_theme = "shibuya"
 html_static_path = []
+html_baseurl = "https://canaille.readthedocs.io/"
 html_theme_options = {
     "accent_color": "yellow",
     "gitlab_url": "https://gitlab.com/yaal/canaille",

poetry.lock

@@ -1711,6 +1711,20 @@ sphinx = "*"
 dev = ["pre-commit (>=3.6,<4.0)", "sphinx-issues[tests]", "tox"]
 tests = ["pytest"]
 
+[[package]]
+name = "sphinx-sitemap"
+version = "2.5.1"
+description = "Sitemap generator for Sphinx"
+optional = false
+python-versions = "*"
+files = [
+    {file = "sphinx-sitemap-2.5.1.tar.gz", hash = "sha256:984bef068bbdbc26cfae209a8b61392e9681abc9191b477cd30da406e3a60ee5"},
+    {file = "sphinx_sitemap-2.5.1-py3-none-any.whl", hash = "sha256:0b7bce2835f287687f75584d7695e4eb8efaec028e5e7b36e9f791de3c344686"},
+]
+
+[package.dependencies]
+sphinx = ">=1.2"
+
 [[package]]
 name = "sphinxcontrib-applehelp"
 version = "1.0.4"
@@ -2112,4 +2126,4 @@ sql = ["passlib", "sqlalchemy", "sqlalchemy-json", "sqlalchemy-utils"]
 [metadata]
 lock-version = "2.0"
 python-versions = "^3.8"
-content-hash = "8ae8b74a082bc9c3fab61ec59c021f4856fefb07cc3555f1eee085fe32e5e0bb"
+content-hash = "cdad69187a2573f15ce7f046afe8ba1ed502498149b7cc5970f8401b9ac724e4"

pyproject.toml

@@ -71,6 +71,7 @@ optional = true
 [tool.poetry.group.doc.dependencies]
 shibuya = "^2024.3.1"
 sphinx = "^7.0.0"
+sphinx-sitemap = "^2.5.1"
 sphinx-issues = "^4.0.0"
 
 [tool.poetry.group.dev.dependencies]