improving granularity of documentation

ofloveandhate · Jul 12, 2024 · 93a3152 · 93a3152
1 parent 29af091
commit 93a3152
Show file tree

Hide file tree

Showing 5 changed files with 75 additions and 4 deletions.
diff --git a/docs/classes.rst b/docs/classes.rst
@@ -0,0 +1,42 @@
+Concrete Classes
+-------------------
+
+
+
+.. autoclass:: markdown2canvas.Page
+   :members:
+   :undoc-members:
+
+
+.. autoclass:: markdown2canvas.Assignment
+   :members:
+   :undoc-members:
+
+
+
+.. autoclass:: markdown2canvas.File
+   :members:
+   :undoc-members:
+
+
+.. autoclass:: markdown2canvas.BareFile
+   :members:
+   :undoc-members:
+
+
+
+
+
+
+
+Base Classes
+--------------
+
+.. autoclass:: markdown2canvas.CanvasObject
+   :members:
+   :undoc-members:
+
+
+.. autoclass:: markdown2canvas.Document
+   :members:
+   :undoc-members:
diff --git a/docs/exceptions.rst b/docs/exceptions.rst
@@ -0,0 +1,14 @@
+Exceptions
+-------------
+
+.. autoclass:: markdown2canvas.AlreadyExists
+   :members:
+   :undoc-members:
+
+.. autoclass:: markdown2canvas.SetupError
+   :members:
+   :undoc-members:
+
+.. autoclass:: markdown2canvas.DoesntExist
+   :members:
+   :undoc-members:
diff --git a/docs/free_functions.rst b/docs/free_functions.rst
@@ -0,0 +1,3 @@
+Free functions
+------------------
+
diff --git a/docs/index.rst b/docs/index.rst
@@ -53,8 +53,7 @@ Details 📝
 ================
 
 .. toctree::
-   :maxdepth: 0
-   :caption: Contents:
+   :maxdepth: 1
 
    markdown2canvas
 

diff --git a/docs/markdown2canvas.rst b/docs/markdown2canvas.rst
@@ -8,5 +8,18 @@ This is the detailed list of all functions and types available in the library.
 Python libraries used: `canvasapi`
 
 
-.. automodule:: markdown2canvas
-   :members:
+
+.. toctree::
+   :maxdepth: 2
+
+   classes
+   exceptions
+   free_functions
+
+
+
+
+
+
+
+