feat: update copyright statement, add license line (#105)

* footer: update copyright statement, add license line

For #104:

Requires the `license.name` and `license.url` config values.

The format is now the standard: `© <year> <holder>`

Places the license on a separate line and provides an optional link to
it.

Other:

It turns out that `author` isn't part of the standard Sphinx config, so
I copied it into the `html_context`.

* chore: syntax fix for black linting

---------

Co-authored-by: Michael Park <michael.park@canonical.com>

Author: medubelko

canonical_sphinx/theme/templates/footer.html

@@ -43,15 +43,26 @@
     <div class="copyright">
       {%- if hasdoc('copyright') %}
         {% trans path=pathto('copyright'), copyright=copyright|e -%}
-          <a href="{{ path }}">Copyright</a> &#169; {{ copyright }}
+          <a href="{{ path }}">&copy; {{ copyright }} {{ author }}</a>
         {%- endtrans %}
       {%- else %}
         {% trans copyright=copyright|e -%}
-          Copyright &#169; {{ copyright }}
+          &copy; {{ copyright }} {{ author }}
         {%- endtrans %}
       {%- endif %}
     </div>
     {%- endif %}
+    {%- if license and license.name -%}
+      {%- if license.url -%}
+      <div class="license">
+        This page is licensed under <a href="{{ license.url }}">{{ license.name }}</a>
+      </div>
+      {%- else -%}
+      <div class="license">
+        This page is licensed under {{ license.name }}
+      </div>
+      {%- endif -%}
+    {%- endif -%}
 
     {# mod: removed "Made with" #}
 

docs/conf.py

@@ -4,16 +4,21 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
 project = "canonical-sphinx"
-copyright = "2024, Canonical"
-author = "Canonical"
+copyright = "2024"
+author = "Canonical Ltd."
 
 extensions = [
     "canonical_sphinx",
 ]
 
 html_context = {
+    "author": author,
     "product_page": "github.com/canonical/canonical-sphinx",
     "github_url": "https://github.com/canonical/canonical-sphinx",
+    "license": {
+        "name": "LGPL-3.0-only",
+        "url": "test.com",
+    },
 }
 
 html_theme_options = {

example/conf.py

@@ -40,7 +40,7 @@
 # curl -H 'Authorization: token <TOKEN>' \
 #   -H 'Accept: application/vnd.github.v3.raw' \
 #   https://api.github.com/repos/canonical/<REPO> | jq '.created_at'
-copyright = f"{datetime.today().year}, {author}"
+copyright = f"{datetime.today().year}"
 
 # Set the path to your own static assets here
 html_static_path = ["_static"]
@@ -57,6 +57,18 @@
     # header) to ".sphinx/_static" and change the path here (start with "_static")
     # (default is the circle of friends)
     "product_tag": "_static/example-tag.png",
+    # Inherit the author value
+    "author": author,
+    # Change your product's license name and a link to its file.
+    # For the name, we recommend using the standard shorthand identifier from
+    # https://spdx.org/licenses
+    # For the URL, link directly to the canonical license statement, typically found on
+    # the product's home page or in its GitHub project.
+    #
+    "license": {
+        "name": "LGPL-3.0-only",
+        "url": "https://github.com/canonical/sphinx-docs-starter-pack/blob/main/LICENSE",
+    },
     # Change to the discourse instance you want to be able to link to
     # using the :discourse: metadata at the top of a file
     # (use an empty value if you don't want to link)

tests/integration/test_canonical_sphinx.py

@@ -59,7 +59,7 @@ def test_canonical_sphinx(example_project):
     # Copyright
     copyright_ = soup.find("div", {"class": "copyright"}).string.strip()
     year = datetime.today().year
-    assert copyright_ == f"Copyright © {year}, Example Project Authors"
+    assert copyright_ == f"© {year} Example Project Authors"
 
     # Logo
     logo = soup.find("a", {"class": "p-logo"})