Merge branch 'feature/summer2024' of https://github.com/ofloveandhate…

…/markdown2canvas into feature/summer2024
ofloveandhate · Jul 16, 2024 · 268ce4b · 268ce4b
2 parents 32be458 + 9b85ee9
commit 268ce4b
Show file tree

Hide file tree

Showing 24 changed files with 2,009 additions and 1,689 deletions.
diff --git a/docs/classes.rst → docs/canvas_objects.rst b/docs/classes.rst → docs/canvas_objects.rst
@@ -1,5 +1,5 @@
-Concrete Classes
--------------------
+Concrete Classes for Canvas Objects
+--------------------------------------
 
 
 
@@ -12,6 +12,14 @@ Concrete Classes
    :members:
    :undoc-members:
 
+.. autoclass:: markdown2canvas.Image
+   :members:
+   :undoc-members:
+
+
+.. autoclass:: markdown2canvas.Link
+   :members:
+   :undoc-members:
 
 
 .. autoclass:: markdown2canvas.File
@@ -32,11 +40,11 @@ Concrete Classes
 Base Classes
 --------------
 
-.. autoclass:: markdown2canvas.CanvasObject
+.. autoclass:: markdown2canvas.canvas_objects.CanvasObject
    :members:
    :undoc-members:
 
 
-.. autoclass:: markdown2canvas.Document
+.. autoclass:: markdown2canvas.canvas_objects.Document
    :members:
    :undoc-members:
diff --git a/docs/exceptions.rst b/docs/exceptions.rst
@@ -1,14 +1,14 @@
 Exceptions
 -------------
 
-.. autoclass:: markdown2canvas.AlreadyExists
+.. autoclass:: markdown2canvas.exception.AlreadyExists
    :members:
    :undoc-members:
 
-.. autoclass:: markdown2canvas.SetupError
+.. autoclass:: markdown2canvas.exception.SetupError
    :members:
    :undoc-members:
 
-.. autoclass:: markdown2canvas.DoesntExist
+.. autoclass:: markdown2canvas.exception.DoesntExist
    :members:
    :undoc-members:
diff --git a/docs/free_functions.rst b/docs/free_functions.rst
@@ -1,3 +1,30 @@
 Free functions
-------------------
+=====================
+
+
+Setup functions
+-------------------
+
+.. automodule:: markdown2canvas.setup_functions
+   :members:
+
+
+
+Functions for interacting with a course on Canvas
+---------------------------------------------------
+
+.. automodule:: markdown2canvas.course_interaction_functions
+   :members:
+
+
+Functions markdown2canvas uses to translate from markdown to Canvas-html
+--------------------------------------------------------------------------
+
+.. automodule:: markdown2canvas.translation_functions
+   :members:
+
+.. autofunction:: markdown2canvas.canvas_objects.find_local_images
+
+.. autofunction:: markdown2canvas.canvas_objects.find_local_files
+
 
diff --git a/docs/markdown2canvas.rst b/docs/markdown2canvas.rst
@@ -12,7 +12,7 @@ Python libraries used: `canvasapi`
 .. toctree::
    :maxdepth: 2
 
-   classes
+   canvas_objects
    exceptions
    free_functions
 

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,2 +1,3 @@
 canvasapi
-Pygments
+Pygments
+markdown