Apply suggestions from code review

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
canonical · Nov 29, 2024 · 41238ac · 41238ac
1 parent 524679e
commit 41238ac
Show file tree

Hide file tree

Showing 15 changed files with 49 additions and 0 deletions.
diff --git a/docs/.readthedocs.yaml b/docs/.readthedocs.yaml
@@ -1,3 +1,6 @@
+# Copyright 2024 Canonical Ltd.
+# See LICENSE file for licensing details.
+
 # .readthedocs.yaml
 # Read the Docs configuration file
 # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

diff --git a/docs/.sphinx/_static/css/pdf.css b/docs/.sphinx/_static/css/pdf.css
@@ -1,3 +1,8 @@
+/*
+ * Copyright 2024 Canonical Ltd.
+ * See LICENSE file for licensing details.
+ */
+
 /* Only relevant for specific PDF generation issues */
 
 .rubric>.hclass2 {

diff --git a/docs/.sphinx/_templates/header.html b/docs/.sphinx/_templates/header.html
@@ -1,3 +1,8 @@
+<!--
+  ~ Copyright 2024 Canonical Ltd.
+  ~ See LICENSE file for licensing details.
+-->
+
 <header id="header" class="p-navigation">
 
   <div class="p-navigation__nav" role="menubar">

diff --git a/docs/.sphinx/get_vale_conf.py b/docs/.sphinx/get_vale_conf.py
@@ -1,3 +1,6 @@
+# Copyright 2024 Canonical Ltd.
+# See LICENSE file for licensing details.
+
 #! /usr/bin/env python
 
 import requests

diff --git a/docs/.sphinx/metrics/build_metrics.sh b/docs/.sphinx/metrics/build_metrics.sh
@@ -1,3 +1,6 @@
+# Copyright 2024 Canonical Ltd.
+# See LICENSE file for licensing details.
+
 #!/bin/bash
 # shellcheck disable=all
 

diff --git a/docs/.sphinx/metrics/source_metrics.sh b/docs/.sphinx/metrics/source_metrics.sh
@@ -1,3 +1,6 @@
+# Copyright 2024 Canonical Ltd.
+# See LICENSE file for licensing details.
+
 #!/bin/bash
 # shellcheck disable=all
 

diff --git a/docs/.sphinx/spellingcheck.yaml b/docs/.sphinx/spellingcheck.yaml
@@ -1,3 +1,6 @@
+# Copyright 2024 Canonical Ltd.
+# See LICENSE file for licensing details.
+
 matrix:
   - name: rST files
     aspell:

diff --git a/docs/Makefile b/docs/Makefile
@@ -1,3 +1,6 @@
+# Copyright 2024 Canonical Ltd.
+# See LICENSE file for licensing details.
+
 # 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.

diff --git a/docs/conf.py b/docs/conf.py
@@ -1,3 +1,6 @@
+# Copyright 2024 Canonical Ltd.
+# See LICENSE file for licensing details.
+
 import datetime
 import ast
 

diff --git a/docs/doc-cheat-sheet.rst b/docs/doc-cheat-sheet.rst
@@ -1,3 +1,6 @@
+.. Copyright 2024 Canonical Ltd.
+.. See LICENSE file for licensing details.
+
 :orphan:
 
 .. vale off

diff --git a/docs/explanation/index.rst b/docs/explanation/index.rst
@@ -1,3 +1,6 @@
+.. Copyright 2024 Canonical Ltd.
+.. See LICENSE file for licensing details.
+
 Explanation
 ===========
 

diff --git a/docs/how-to/contributing.rst b/docs/how-to/contributing.rst
@@ -1,3 +1,6 @@
+.. Copyright 2024 Canonical Ltd.
+.. See LICENSE file for licensing details.
+
 .. TODO: Replace all mentions of ACME with your project name
 .. TODO: Update all sections containing TODOs; make sure no TODOs are left
 

diff --git a/docs/how-to/index.rst b/docs/how-to/index.rst
@@ -1,3 +1,6 @@
+.. Copyright 2024 Canonical Ltd.
+.. See LICENSE file for licensing details.
+
 How-to guides
 =============
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,3 +1,6 @@
+.. Copyright 2024 Canonical Ltd.
+.. See LICENSE file for licensing details.
+
 12-Factor app support in Charmcraft and Rockcraft
 =================================================
 

diff --git a/docs/tutorial/index.rst b/docs/tutorial/index.rst
@@ -1,3 +1,6 @@
+.. Copyright 2024 Canonical Ltd.
+.. See LICENSE file for licensing details.
+
 Tutorials
 =========