docs: update starter pack version

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

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

.github/workflows/markdown-style-checks.yml

@@ -1,21 +1,24 @@
-name: "Linter for Markdown"
+name: Markdown style checks
 
 on:
   push:
     branches:
-      - main
+    - main
+    paths:
+    - 'docs/**'   # Only run on changes to the docs directory
   pull_request:
     branches:
-      - '*'
+    - '*'
+    paths:
+    - 'docs/**'   # Only run on changes to the docs directory
 
 jobs:
   markdown-lint:
     runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0     
-      - uses: DavidAnson/markdownlint-cli2-action@v16
-        with:
-          config: "docs/.sphinx/.markdownlint.json"
-          working-directory: "docs"
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+    - uses: DavidAnson/markdownlint-cli2-action@v16
+      with:
+        config: "docs/.sphinx/.markdownlint.json"

docs/.custom_wordlist.txt

@@ -1,36 +1,75 @@
+# Leave a blank line at the end of this file to support concatenation
 abi
+ack'd
+Ack'd
+Ack's
+Acked
 amd
 backport
-backports
 backported
+backports
 BugLink
+cjk
+commit's
 config
 configs
+creativecommons
 cryptographically
-customisation
 customizations
 CVE
 debian
 Dev
+devel
 Devel
+DeveloperApplicationTemplate
 dkms
+DKMSUploadApplication
+DMB
+dvipng
 eol
 ESM
 filebug
+fonts
+forgejo
+freefont
 Gitea
+github
+GPG
+gyre
 https
 hwe
 IoT
+irc
 Kconfig
+KernelGitGuide
+KernelTeam
+KernelUpdates
+kustom
+lang
+latexmk
+libera
+lifecycle
 linux
+LuisHenriques
 manpages
 Mantic
 metapackage
+mofed
+motu
+Nack'd
 oem
+otf
+packageset
+PaoloPisati
 patchset
+PerPackageUploaderApplication
+plantuml
 PPAs
+PPUApplicationTemplate
+repo
 respin
 respins
+sa
 selftests
 sha
 snapcraft
@@ -39,8 +78,20 @@ src
 sru
 SRUs
 Tahr
+tex
+texlive
+TOC
+txt
 ubuntu
 UC
 uncomment
+Unported
+uploaders
+upstreamed
+utils
+WCAG
+wordlist
 Xenial
-Xerus
+Xerus
+xetex
+xindy

docs/.gitignore

@@ -1,17 +1,25 @@
-
-# Starter pack rules start here
-/*env*/
+# Environment
+*env*/
 .sphinx/venv/
+
+# Sphinx
 .sphinx/warnings.txt
 .sphinx/.wordlist.dic
 .sphinx/.doctrees/
 .sphinx/node_modules/
-package*.json
+
+# Vale
+.sphinx/styles/*
+.sphinx/vale.ini
+
+# Build outputs
 _build
+
+# Node.js
+package*.json
+
+# Unrelated cache and config files
 .DS_Store
 __pycache__
 .idea/
 .vscode/
-.sphinx/styles/*
-.sphinx/vale.ini
-sp-docs/_build

docs/.readthedocs.yaml

@@ -12,7 +12,17 @@ build:
     python: "3.11"
   jobs:
     pre_install:
-      - git fetch --unshallow || true
+    - git fetch --unshallow || true
+    post_checkout:
+    # 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
 sphinx:
@@ -22,9 +32,9 @@ sphinx:
 
 # If using Sphinx, optionally build your docs in additional formats such as PDF
 formats:
-  - pdf
+- pdf
 
 # Optionally declare the Python requirements required to build your docs
 python:
   install:
-    - requirements: docs/.sphinx/requirements.txt
+  - requirements: docs/.sphinx/requirements.txt

docs/.sphinx/.markdownlint.json

@@ -1,13 +1,24 @@
 {
     "default": false,
-    "MD003": { "style": "atx" },
-    "MD013": { "code_blocks": false, "tables": false, "stern": true, "line_length": 150},
+    "MD003": {
+        "style": "atx"
+    },
+    "MD013": {
+        "code_blocks": false,
+        "tables": false,
+        "stern": true,
+        "line_length": 150
+    },
     "MD014": true,
     "MD018": true,
     "MD022": true,
     "MD023": true,
-    "MD026": { "punctuation": ".,;。，；"},
-    "MD031": { "list_items": false},
+    "MD026": {
+        "punctuation": ".,;。，；"
+    },
+    "MD031": {
+        "list_items": false
+    },
     "MD032": true,
     "MD035": true,
     "MD042": true,

docs/.sphinx/.pre-commit-config.yaml

@@ -0,0 +1,23 @@
+repos:
+  - repo: local
+    hooks:
+      - id: make-spelling
+        name: Run make spelling
+        entry: make -C docs spelling
+        language: system
+        pass_filenames: false
+        files: ^docs/.*\.(rst|md|txt)$
+
+      - id: make-linkcheck
+        name: Run make linkcheck
+        entry: make -C docs linkcheck
+        language: system
+        pass_filenames: false
+        files: ^docs/.*\.(rst|md|txt)$
+
+      - id: make-woke
+        name: Run make woke
+        entry: make -C docs woke
+        language: system
+        pass_filenames: false
+        files: ^docs/.*\.(rst|md|txt)$