Merge branch 'main' into ROCKS-918/feat/upgrade-to-pydantic-2.x

.github/.jira_sync_config.yaml

@@ -0,0 +1,25 @@
+settings:
+  components:
+    - Craft Archives
+  labels:
+    - Bug
+    - Enhancement
+    - Spike
+    - Epic
+  # Adds a comment with the JIRA ID
+  add_gh_comment: true
+  # Reflect changes on JIRA
+  sync_description: true
+  # Comments are synced from Github to JIRA
+  # Nothing goes from JIRA to Github
+  sync_comments: true
+  # epic_key: "MTC-296"
+  jira_project_key: "CRAFT"
+  status_mapping:
+    opened: Untriaged
+    closed: done
+  label_mapping:
+    Enhancement: Story
+    Bug: Bug
+    Spike: Spike
+    Epic: Epic

.readthedocs.yaml

@@ -12,7 +12,6 @@ sphinx:
 # Optionally build your docs in additional formats such as PDF
 formats:
   - pdf
-  - epub
 
 build:
   os: ubuntu-22.04

docs/conf.py

@@ -1,47 +1,51 @@
-# Configuration file for the Sphinx documentation builder.
+# Copyright 2023-2024 Canonical Ltd.
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License version 3 as published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program; if not, write to the Free Software Foundation,
+# Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 #
-# For the full list of built-in configuration values, see the documentation:
-# https://www.sphinx-doc.org/en/master/usage/configuration.html
-
-# -- Project information -----------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = "craft-archives"
-copyright = "2023, Canonical"
-author = "Canonical"
+import datetime
 
-# region General configuration
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+project = "Craft Archives"
+author = "Canonical Group Ltd"
 
-extensions = [
-    "sphinx.ext.intersphinx",
-    "sphinx.ext.viewcode",
-    "sphinx.ext.coverage",
-    "sphinx.ext.doctest",
-    "sphinx_design",
-    "sphinx_copybutton",
-    "sphinx-pydantic",
-    "sphinx_toolbox",
-    "sphinx_toolbox.more_autodoc",
-    "sphinx.ext.autodoc",  # Must be loaded after more_autodoc
-]
+copyright = "2023-%s, %s" % (datetime.date.today().year, author)
 
-templates_path = ["_templates"]
-exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+# region Configuration for canonical-sphinx
+ogp_site_url = "https://canonical-craft-archives.readthedocs-hosted.com/"
+ogp_site_name = project
 
-show_authors = False
+html_context = {
+    "product_page": "github.com/canonical/craft-archives",
+    "github_url": "https://github.com/canonical/craft-archives",
+}
 
+extensions = [
+    "canonical_sphinx",
+]
 # endregion
-# region Options for HTML output
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = "furo"
-html_static_path = ["_static"]
-html_css_files = [
-    "css/custom.css",
-]
+extensions.extend(
+    [
+        "sphinx.ext.intersphinx",
+        "sphinx.ext.viewcode",
+        "sphinx-pydantic",
+        "sphinx_toolbox",
+        "sphinx_toolbox.more_autodoc",
+        "sphinx.ext.autodoc",  # Must be loaded after more_autodoc
+    ]
+)
 
-# endregion
 # region Options for extensions
 # Intersphinx extension
 # https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#configuration

pyproject.toml

@@ -47,11 +47,8 @@ types = [
     "pyright==1.1.326",
 ]
 docs = [
-    "furo==2023.5.20",
-    "sphinx>=6.2.1,<7.0",
+    "canonical-sphinx~=0.1",
     "sphinx-autobuild==2021.3.14",
-    "sphinx-copybutton==0.5.2",
-    "sphinx-design==0.4.1",
     "sphinx-pydantic==0.1.1",
     "sphinx-toolbox==3.4.0",
     "sphinx-lint==0.6.7",