Merge pull request #29 from krishnasism/chore/fix-layout-of-docs-0115…

…2024 Fix documentation layout
weareprestatech · Jan 15, 2024 · 02a8a2e · 02a8a2e
2 parents f8cb302 + e3b6ad2
commit 02a8a2e
Show file tree

Hide file tree

Showing 5 changed files with 108 additions and 3 deletions.
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -13,3 +13,6 @@ API
    hotpdf.utils
    hotpdf.processor
    hotpdf.helpers.nanoid
+   hotpdf.data.classes.HotCharacter
+   hotpdf.data.classes.Span
+   hotpdf.data.classes.ElementDimension
diff --git a/docs/source/generated/hotpdf.data.classes.ElementDimension.rst b/docs/source/generated/hotpdf.data.classes.ElementDimension.rst
@@ -0,0 +1,32 @@
+hotpdf.data.classes.ElementDimension
+====================================
+
+.. currentmodule:: hotpdf.data.classes
+
+.. autoclass:: ElementDimension
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~ElementDimension.__init__
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~ElementDimension.span_id
+      ~ElementDimension.x0
+      ~ElementDimension.y0
+      ~ElementDimension.x1
+      ~ElementDimension.y1
+
+
diff --git a/docs/source/generated/hotpdf.data.classes.HotCharacter.rst b/docs/source/generated/hotpdf.data.classes.HotCharacter.rst
@@ -0,0 +1,32 @@
+hotpdf.data.classes.HotCharacter
+================================
+
+.. currentmodule:: hotpdf.data.classes
+
+.. autoclass:: HotCharacter
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~HotCharacter.__init__
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~HotCharacter.span_id
+      ~HotCharacter.value
+      ~HotCharacter.x
+      ~HotCharacter.y
+      ~HotCharacter.x_end
+
+
diff --git a/docs/source/generated/hotpdf.data.classes.Span.rst b/docs/source/generated/hotpdf.data.classes.Span.rst
@@ -0,0 +1,32 @@
+hotpdf.data.classes.Span
+========================
+
+.. currentmodule:: hotpdf.data.classes
+
+.. autoclass:: Span
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~Span.__init__
+
+
+
+
+
+   .. rubric:: Attributes
+
+   .. autosummary::
+
+      ~Span.characters
+      ~Span.x0
+      ~Span.y0
+      ~Span.x_end
+      ~Span.span_id
+
+
diff --git a/docs/source/usage.rst b/docs/source/usage.rst
@@ -1,15 +1,18 @@
 Usage
------
+=====
 
 Basic usage is as follows:
 
-Loading a file
----------------------
+HotPdf Class
+------------------------------------------
 
 .. autoclass:: hotpdf.HotPdf
 
 The HotPdf class is the wrapper around your PDF that allows for searching text and extracting text on your PDFs.
 
+Loading a file
+------------------------------------------
+
 Before you can perform operations on your PDFs, you will need to load it first.
 
 .. code-block:: python
@@ -24,6 +27,9 @@ Before you can perform operations on your PDFs, you will need to load it first.
 File Operations
 ------------------------------------------
 
+Length
+^^^^^^^
+
 The number of pages in the PDF file can be determined by checking the `len` of `pages` property of the hotpdf object.
 
 .. code-block:: python