From c226aeb098c637492b814bf7f9d175a9bdf002ad Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Thu, 20 Jun 2024 17:20:46 -0700 Subject: [PATCH 1/5] Allow docs to build on Python 3.12 by replacing `pkg_resources` with `importlib.metadata`. - Fix underline length in README.rst --- README.rst | 2 +- docs/conf.py | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 8ce4dae2..008c2313 100644 --- a/README.rst +++ b/README.rst @@ -43,7 +43,7 @@ files. .. _`BSD`: https://github.com/collective/icalendar/issues/2 Quick start guide ------------ +----------------- ``icalendar`` enables you to **create**, **inspect** and **modify** calendaring information with Python. diff --git a/docs/conf.py b/docs/conf.py index fad2b42c..a46c8829 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,5 +1,5 @@ # icalendar documentation build configuration file -import pkg_resources +import importlib.metadata import datetime import os @@ -28,7 +28,7 @@ project = 'icalendar' this_year = datetime.date.today().year copyright = f'{this_year}, Plone Foundation' -version = pkg_resources.get_distribution('icalendar').version +version = importlib.metadata.version('icalendar') release = version exclude_patterns = ['_build', 'lib', 'bin', 'include', 'local'] From 7d278e05e52f5bd0e1d63dac247bf27e302443f8 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Thu, 20 Jun 2024 17:26:05 -0700 Subject: [PATCH 2/5] Add change log --- CHANGES.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CHANGES.rst b/CHANGES.rst index 4dcf56bd..44771e55 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -31,6 +31,9 @@ Breaking changes: import icalendar icalendar.use_pytz() +- Replaced ``pkg_resources.get_distribution`` with ``importlib.metadata`` in + ``docs/conf.py`` to allow building docs on Python 3.12. + New features: - ... From f2a882c7b763cae9d217e8046dde2111225e71e2 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Thu, 20 Jun 2024 17:27:12 -0700 Subject: [PATCH 3/5] Add myself to credits.rst --- docs/credits.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/credits.rst b/docs/credits.rst index 8be83a31..5d17ec44 100644 --- a/docs/credits.rst +++ b/docs/credits.rst @@ -73,6 +73,7 @@ icalendar contributors - Matt Lewis - Felix Stupp - Bastian Wegge +- `Steve Piercy `_ Find out who contributed:: From c24f364d6f8cac65e22afe319d359920ec28fc3d Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Thu, 20 Jun 2024 17:42:05 -0700 Subject: [PATCH 4/5] Add missing public classes and functions to API documentation - Fix docstring underline mismatch error Fixes #631. Might depend on #636? --- docs/api.rst | 30 ++++++++++++++++++++++++++++++ src/icalendar/prop.py | 1 + 2 files changed, 31 insertions(+) diff --git a/docs/api.rst b/docs/api.rst index fc1ae79a..6023e13b 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -7,8 +7,38 @@ icalendar.cal .. automodule:: icalendar.cal :members: +icalendar.caselessdict +++++++++++++++++++++++ + +.. automodule:: icalendar.caselessdict + :members: + +icalendar.cli ++++++++++++++ + +.. automodule:: icalendar.cli + :members: + +icalendar.parser +++++++++++++++++ + +.. automodule:: icalendar.parser + :members: + +icalendar.parser_tools +++++++++++++++++++++++ + +.. automodule:: icalendar.parser_tools + :members: + icalendar.prop ++++++++++++++ .. automodule:: icalendar.prop :members: + +icalendar.tools ++++++++++++++++ + +.. automodule:: icalendar.tools + :members: diff --git a/src/icalendar/prop.py b/src/icalendar/prop.py index 795400fd..2ae5590d 100644 --- a/src/icalendar/prop.py +++ b/src/icalendar/prop.py @@ -2,6 +2,7 @@ prefer) for the classes/datatypes that are used in iCalendar: ########################################################################### + # This module defines these property value data types and property parameters 4.2 Defined property parameters are: From ed7de76c295f7446237592fe80b54f1b4f0c75d4 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Thu, 20 Jun 2024 17:46:08 -0700 Subject: [PATCH 5/5] Add change log --- CHANGES.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGES.rst b/CHANGES.rst index 44771e55..92b2fc87 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -36,7 +36,7 @@ Breaking changes: New features: -- ... +- Added missing public classes and functions to API documentation. Bug fixes: