DOC: Fix documentation for PdfDocCommon (py-pdf#3013)

* DOC: Fix documentation for PdfDocCommon Closes py-pdf#1493. * use cross-references
j-t-1 · Jan 1, 2025 · c358ca5 · c358ca5
1 parent 746df67
commit c358ca5
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 5 deletions.
diff --git a/docs/modules/PdfDocCommon.md b/docs/modules/PdfDocCommon.md
diff --git a/docs/modules/PdfDocCommon.rst b/docs/modules/PdfDocCommon.rst
@@ -0,0 +1,12 @@
+The PdfDocCommon Class
+----------------------
+
+**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.
+
+.. autoclass:: pypdf._doc_common.PdfDocCommon
+    :members:
+    :inherited-members:
+    :undoc-members:
+    :show-inheritance: