chore: set base doc url and reference slug

canonical · Jun 21, 2024 · 3f0228d · 3f0228d
1 parent 7718957
commit 3f0228d
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/rockcraft/application.py b/rockcraft/application.py
@@ -34,6 +34,7 @@
     ProjectClass=project.Project,
     BuildPlannerClass=project.BuildPlanner,
     source_ignore_patterns=["*.rock"],
+    docs_url="https://documentation.ubuntu.com/rockcraft/en/stable",
 )
 
 

diff --git a/rockcraft/models/project.py b/rockcraft/models/project.py
@@ -263,6 +263,11 @@ def get_build_plan(self) -> list[BuildInfo]:
 
         return build_infos
 
+    @override
+    @classmethod
+    def model_reference_slug(cls) -> str | None:
+        return "/reference/rockcraft.yaml"
+
 
 class Project(YamlModelMixin, BuildPlanner, BaseProject):  # type: ignore[misc]
     """Rockcraft project definition."""
@@ -512,6 +517,11 @@ def unmarshal(cls, data: dict[str, Any]) -> Self:
 
         return cls(**data)
 
+    @override
+    @classmethod
+    def model_reference_slug(cls) -> str | None:
+        return "/reference/rockcraft.yaml"
+
 
 def load_project(filename: Path) -> dict[str, Any]:
     """Load and unmarshal the project YAML file.