Update starter pack

.github/workflows/automatic-doc-checks.yml

@@ -1,14 +1,23 @@
-name: Main Documentation Checks
+name: Automatic doc checks
+
+#on:
+#  push:
+#    branches: [ main ]
+#  pull_request:
+#    paths:
+#      - 'docs/**'   # Only run on changes to the docs directory
+
+  workflow_dispatch:
+    # Manual trigger
 
-on:
-  - workflow_dispatch
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: true  
+  cancel-in-progress: true
 
 jobs:
   documentation-checks:
     uses: canonical/documentation-workflows/.github/workflows/documentation-checks.yaml@main
     with:
-      working-directory: '.'
+      working-directory: 'docs'
+      fetch-depth: 0

.github/workflows/cla-check.yaml

@@ -1,8 +1,9 @@
----
+# This workflow checks if the contributor has signed the Canonical Contributor Licence Agreement (CLA)
+name: Canonical Contributor Licence Agreement check
 
-name: cla-check
-
-on: [pull_request_target]
+on:
+  pull_request:
+    branches: [main]
 
 jobs:
   cla-check:

.readthedocs.yaml

@@ -12,14 +12,21 @@ build:
     python: "3.11"
   jobs:
     post_checkout:
-      - python3 .sphinx/build_requirements.py
-  apt_packages:
-    - distro-info
+    - git fetch --unshallow || true
+    # Cancel building pull requests when there aren't changed in the docs directory.
+    # If there are no changes (git diff exits with 0) we force the command to return with 183.
+    # This is a special exit code on Read the Docs that will cancel the build immediately.
+    # https://docs.readthedocs.io/en/stable/build-customization.html#cancel-build-based-on-a-condition
+    - |
+      if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- 'docs/' '.readthedocs.yaml';
+      then
+        exit 183;
+      fi
 
-# Build documentation in the docs/ directory with Sphinx
+# Build documentation with Sphinx
 sphinx:
   builder: dirhtml
-  configuration: conf.py
+  configuration: docs/conf.py
   fail_on_warning: false
 
 # If using Sphinx, optionally build your docs in additional formats such as PDF
@@ -29,4 +36,4 @@ formats:
 # Optionally declare the Python requirements required to build your docs
 python:
    install:
-   - requirements: .sphinx/requirements.txt
+   - requirements: docs/requirements.txt

Makefile

@@ -1,29 +1,14 @@
-# This Makefile stub allows you to customize starter pack (SP) targets.
-# Consider this file as a bridge between your project
-# and the starter pack's predefined targets that reside in Makefile.sp.
-# 
-# You can add your own, non-SP targets here or override SP targets
-# to fit your project's needs. For example, you can define and use targets
-# named "install" or "run", but continue to use SP targets like "sp-install"
-# or "sp-run" when working on the documentation.
+# Wrapper Makefile to forward all commands to docs/Makefile
+# This allows "make" commands to be run from the root dir
 
-# Put it first so that "make" without argument is like "make help".
-help:
-	@echo "\n" \
-        "------------------------------------------------------------- \n" \
-        "* watch, build and serve the documentation:  make run \n" \
-        "* only build:                                make html \n" \
-        "* only serve:                                make serve \n" \
-        "* clean built doc files:                     make clean-doc \n" \
-        "* clean full environment:                    make clean \n" \
-        "* check links:                               make linkcheck \n" \
-        "* check spelling:                            make spelling \n" \
-        "* check inclusive language:                  make woke \n" \
-        "* check accessibility:                       make pa11y \n" \
-        "* build PDF:                                 make pdf \n" \
-        "* force install packages for PDF generation: make pdf-prep-force \n" \
-        "* other possible targets:                    make <TAB twice> \n" \
-        "------------------------------------------------------------- \n"
+# Get the directory where this Makefile is located (repository root)
+ROOT_DIR := $(dir $(abspath $(lastword $(MAKEFILE_LIST))))
 
+# Forward all targets to the docs/Makefile
+.DEFAULT_GOAL := help
+
+# Catch-all target: route all unknown targets to docs/Makefile
 %:
-	$(MAKE) -f Makefile.sp sp-$@
+	@$(MAKE) -C $(ROOT_DIR)docs $@
+
+.PHONY: help