From 4d7f8df0586a4a5c00654334b1beeb379e6dcf3a Mon Sep 17 00:00:00 2001 From: Artem Konev Date: Fri, 18 Aug 2023 13:58:44 +0100 Subject: [PATCH] add comment on copyright notice format to custom_conf.py Links: - --- custom_conf.py | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/custom_conf.py b/custom_conf.py index fcfe2bc7..c7b0784a 100644 --- a/custom_conf.py +++ b/custom_conf.py @@ -21,7 +21,20 @@ # Uncomment if your product uses release numbers # release = '1.0' -# The default value uses the current year as the copyright year +# The default value uses the current year as the copyright year. +# +# For static works, it is common to provide the year of first publication. +# Another option is to give the first year and the current year +# for documentation that is often changed, e. g. 2022–2023 (note the en-dash). +# +# A way to check a GutHub repo's creation date is to obtain a classic GitHub +# token with 'repo' permissions here: https://github.com/settings/tokens +# Next, use 'curl' and 'jq' to extract the date from the GitHub API's output: +# +# curl -H 'Authorization: token ' \ +# -H 'Accept: application/vnd.github.v3.raw' \ +# https://api.github.com/repos/canonical/ | jq '.created_at' + copyright = '%s, %s' % (datetime.date.today().year, author) ## Open Graph configuration - defines what is displayed in the website preview