From ff472084d4a6dc1ea2899c451e85f9785c886d7b Mon Sep 17 00:00:00 2001 From: stefan6419846 <96178532+stefan6419846@users.noreply.github.com> Date: Fri, 20 Dec 2024 11:09:14 +0100 Subject: [PATCH 1/2] DOC: Fix documentation for PdfDocCommon Closes #1493. --- docs/modules/PdfDocCommon.md | 5 ----- docs/modules/PdfDocCommon.rst | 12 ++++++++++++ 2 files changed, 12 insertions(+), 5 deletions(-) delete mode 100644 docs/modules/PdfDocCommon.md create mode 100644 docs/modules/PdfDocCommon.rst diff --git a/docs/modules/PdfDocCommon.md b/docs/modules/PdfDocCommon.md deleted file mode 100644 index 9a26d1e8b..000000000 --- a/docs/modules/PdfDocCommon.md +++ /dev/null @@ -1,5 +0,0 @@ -# The PdfDocCommon Class - -**PdfDocCommon** is an abstract class which is inherited by **PdfReader** and **PdfWriter** - -Where identified in the API, you can use any of the derived class. diff --git a/docs/modules/PdfDocCommon.rst b/docs/modules/PdfDocCommon.rst new file mode 100644 index 000000000..7e5076dea --- /dev/null +++ b/docs/modules/PdfDocCommon.rst @@ -0,0 +1,12 @@ +The PdfDocCommon Class +---------------------- + +**PdfDocCommon** is an abstract class which is inherited by **PdfReader** and **PdfWriter** + +Where identified in the API, you can use any of the derived class. + +.. autoclass:: pypdf._doc_common.PdfDocCommon + :members: + :inherited-members: + :undoc-members: + :show-inheritance: From 8bbc963352e844b3164f2c226cefade631751914 Mon Sep 17 00:00:00 2001 From: stefan6419846 <96178532+stefan6419846@users.noreply.github.com> Date: Fri, 20 Dec 2024 11:11:55 +0100 Subject: [PATCH 2/2] use cross-references --- docs/modules/PdfDocCommon.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/PdfDocCommon.rst b/docs/modules/PdfDocCommon.rst index 7e5076dea..365981ffb 100644 --- a/docs/modules/PdfDocCommon.rst +++ b/docs/modules/PdfDocCommon.rst @@ -1,7 +1,7 @@ The PdfDocCommon Class ---------------------- -**PdfDocCommon** is an abstract class which is inherited by **PdfReader** and **PdfWriter** +**PdfDocCommon** is an abstract class which is inherited by :class:`~pypdf.PdfReader` and :class:`~pypdf.PdfWriter`. Where identified in the API, you can use any of the derived class.