From a5c6c7f473058648d07e883ade902e98eac928f3 Mon Sep 17 00:00:00 2001 From: Dana Powers Date: Wed, 12 Feb 2025 13:22:26 -0800 Subject: [PATCH] Add .readthedocs.yaml; update copyright date --- .readthedocs.yaml | 35 +++++++++++++++++++++++++++++++++++ docs/conf.py | 2 +- docs/license.rst | 2 +- kafka/__init__.py | 2 +- 4 files changed, 38 insertions(+), 3 deletions(-) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 000000000..dd2aa46c8 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,35 @@ +# Read the Docs configuration file for Sphinx projects +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the OS, Python version and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.12" + # You can also specify other tool versions: + # nodejs: "20" + # rust: "1.70" + # golang: "1.20" + +# Build documentation in the "docs/" directory with Sphinx +sphinx: + configuration: docs/conf.py + # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs + # builder: "dirhtml" + # Fail on all warnings to avoid broken references + # fail_on_warning: true + +# Optionally build your docs in additional formats such as PDF and ePub +# formats: +# - pdf +# - epub + +# Optional but recommended, declare the Python requirements required +# to build your documentation +# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html +# python: +# install: +# - requirements: docs/requirements.txt diff --git a/docs/conf.py b/docs/conf.py index efa8d0807..2bc93bafb 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,7 +48,7 @@ # General information about the project. project = u'kafka-python' -copyright = u'2016 -- Dana Powers, David Arthur, and Contributors' +copyright = u'2025 -- Dana Powers, David Arthur, and Contributors' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the diff --git a/docs/license.rst b/docs/license.rst index e9d5c9adb..f419915bd 100644 --- a/docs/license.rst +++ b/docs/license.rst @@ -6,5 +6,5 @@ License Apache License, v2.0. See `LICENSE `_. -Copyright 2016, Dana Powers, David Arthur, and Contributors +Copyright 2025, Dana Powers, David Arthur, and Contributors (See `AUTHORS `_). diff --git a/kafka/__init__.py b/kafka/__init__.py index d5e30affa..41a014072 100644 --- a/kafka/__init__.py +++ b/kafka/__init__.py @@ -4,7 +4,7 @@ from kafka.version import __version__ __author__ = 'Dana Powers' __license__ = 'Apache License 2.0' -__copyright__ = 'Copyright 2016 Dana Powers, David Arthur, and Contributors' +__copyright__ = 'Copyright 2025 Dana Powers, David Arthur, and Contributors' # Set default logging handler to avoid "No handler found" warnings. import logging