From 93430c9eab4a9cc2d643fc03633359fd86fabe55 Mon Sep 17 00:00:00 2001 From: Marius Vikhammer Date: Mon, 10 Jan 2022 15:03:51 +0800 Subject: [PATCH] docs: update copyright date for docs automatically --- docs/en/COPYRIGHT.rst | 2 +- docs/en/conf.py | 6 +++++- docs/en/contribute/copyright-guide.rst | 6 +++--- docs/zh_CN/conf.py | 6 +++++- tools/ci/mypy_ignore_list.txt | 1 - 5 files changed, 14 insertions(+), 7 deletions(-) diff --git a/docs/en/COPYRIGHT.rst b/docs/en/COPYRIGHT.rst index f1ca2da539a0..705dd2b5bfb9 100644 --- a/docs/en/COPYRIGHT.rst +++ b/docs/en/COPYRIGHT.rst @@ -4,7 +4,7 @@ Copyrights and Licenses Software Copyrights =================== -All original source code in this repository is Copyright (C) 2015-2021 Espressif Systems. This source code is licensed under the Apache License 2.0 as described in the file LICENSE. +All original source code in this repository is Copyright (C) 2015-2022 Espressif Systems. This source code is licensed under the Apache License 2.0 as described in the file LICENSE. Additional third party copyrighted code is included under the following licenses. diff --git a/docs/en/conf.py b/docs/en/conf.py index a2fa8030db92..c69e51b6427d 100644 --- a/docs/en/conf.py +++ b/docs/en/conf.py @@ -14,9 +14,13 @@ sys.path.insert(0, os.path.abspath('../')) from conf_common import * # noqa: F403,F401 +import datetime + +current_year = datetime.datetime.now().year + # General information about the project. project = u'ESP-IDF Programming Guide' -copyright = u'2016 - 2021, Espressif Systems (Shanghai) Co., Ltd' +copyright = u'2016 - {}, Espressif Systems (Shanghai) Co., Ltd'.format(current_year) # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/docs/en/contribute/copyright-guide.rst b/docs/en/contribute/copyright-guide.rst index 20494d8aa95f..62a5be5fb030 100644 --- a/docs/en/contribute/copyright-guide.rst +++ b/docs/en/contribute/copyright-guide.rst @@ -23,7 +23,7 @@ Common Examples of Copyright Headers The simplest case is when the code is not based on any licensed previous work, e.g. it was written completely from scratch. Such code can be decorated with the following copyright header and put under the license of ESP-IDF:: /* - * SPDX-FileCopyrightText: 2015-2021 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2015-2022 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ @@ -34,7 +34,7 @@ Less restrictive parts of ESP-IDF Some parts of ESP-IDF are deliberately under less restrictive licenses in order to ease their re-use in commercial closed source projects. This is the case for :project:`ESP-IDF examples ` which are in Public domain or under the Creative Commons Zero Universal (CC0) license. The following header can be used in such source files:: /* - * SPDX-FileCopyrightText: 2015-2021 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2015-2022 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Unlicense OR CC0-1.0 */ @@ -53,7 +53,7 @@ The following example is a suitable header for a code licensed under the "GNU Ge * * SPDX-License-Identifier: GPL-2.0-or-later * - * SPDX-FileContributor: 2019-2021 Espressif Systems (Shanghai) CO LTD + * SPDX-FileContributor: 2019-2022 Espressif Systems (Shanghai) CO LTD */ The licenses can be identified and the short SPDX identifiers can be found in the official `SPDX license list `_. Other very common licenses are the GPL-2.0-only, the BSD-3-Clause, and the BSD-2-Clause. diff --git a/docs/zh_CN/conf.py b/docs/zh_CN/conf.py index a13d6d79f962..cc6fbc27121a 100644 --- a/docs/zh_CN/conf.py +++ b/docs/zh_CN/conf.py @@ -14,9 +14,13 @@ sys.path.insert(0, os.path.abspath('..')) from conf_common import * # noqa: F403,F401 +import datetime + +current_year = datetime.datetime.now().year + # General information about the project. project = u'ESP-IDF 编程指南' -copyright = u'2016 - 2021 乐鑫信息科技（上海）股份有限公司' +copyright = u'2016 - {} 乐鑫信息科技（上海）股份有限公司'.format(current_year) # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/tools/ci/mypy_ignore_list.txt b/tools/ci/mypy_ignore_list.txt index 24e3307b3b32..4f0b8becc7e9 100644 --- a/tools/ci/mypy_ignore_list.txt +++ b/tools/ci/mypy_ignore_list.txt @@ -48,7 +48,6 @@ docs/sanitize_version.py docs/test/en/conf.py docs/test/test_docs.py docs/test/test_sphinx_idf_extensions.py -docs/zh_CN/conf.py examples/bluetooth/nimble/blecent/blecent_test.py examples/bluetooth/nimble/blehr/blehr_test.py examples/bluetooth/nimble/bleprph/bleprph_test.py