Finalized Documentation for v0.15.0 (#101)

* Added some comments

* Added deprecation warnings

* Added warning

* Cleaned up docs a little

* Updated version history

* Added docs PR

docs/docs/element-api.rst

@@ -3,7 +3,10 @@ The Element API
 
 For users who want a little more control over how
 their markdown is formatted, SnakeMD provides a low-level
-API constructed from elements:
+API constructed of elements.
+
+Element Interface
+-----------------
 
 .. autoclass:: snakemd.Element
    :members:
@@ -31,8 +34,8 @@ like the following Heading example:
 The remainder of this section introduces the Block interface
 as well as all of the Blocks currently available for use. 
 
-Block
-^^^^^
+Block Interface
+^^^^^^^^^^^^^^^
 
 All markdown blocks inherit from the Block interface. 
 

docs/version-history.rst

@@ -10,7 +10,12 @@ In an effort to keep history of all the documentation
 for SnakeMD, we've included all old versions below
 as follows:
 
-* v0.14.0 [:pr:`84`, :pr:`86`, :pr:`89`, :pr:`90`, :pr:`91`]
+* v0.15.0 [:pr:`97`, :pr:`98`, :pr:`99`, :pr:`101`]
+    * Moved README generation code to repo root as a script
+    * Expanded Heading constructor to support list of strings and Inline objects
+    * Migrated code block support from Paragraph class into new Code class
+
+* v0.14.0 [:pr:`84`, :pr:`86`, :pr:`89`, :pr:`90`, :pr:`91`, :pr:`95`]
     * Added Raw block for user formatted text 
     * Replaced InlineText with Inline
     * Added Block and Inline classes 

snakemd/elements.py

@@ -598,6 +598,14 @@ def __init__(self, text: Inline | str, level: int) -> None:
 
 
 class Code(Block):
+    """
+    A code block is a standalone block of syntax-highlighted code.
+    Code blocks can have generic highlighting or highlighting based
+    on their language. 
+
+    .. versionadded:: 0.15.0
+    """
+
     def __init__(self, code: str | Code, lang: str = "generic"):
         super().__init__()
         self._code = code
@@ -624,8 +632,16 @@ class Paragraph(Block):
     :param Iterable[Inline | str] content: a "list" of text objects to render as a paragraph
     :param bool code: the code state of the paragraph;
         set True to convert the paragraph to a code block (i.e., True -> ```code```)
+        
+        .. deprecated:: 0.15.0
+            replaced in favor of the :class:`Code` block
+        
     :param str lang: the language of the code snippet;
         invalid without the code flag set to True
+        
+        .. deprecated:: 0.15.0
+            replaced in favor of the :class:`Code` block
+        
     :param bool quote: the quote state of the paragraph;
         set True to convert the paragraph to a blockquote (i.e., True -> > quote)
     """
@@ -636,7 +652,8 @@ def __init__(self, content: Iterable[Inline | str], code: bool = False, lang: st
         self._code = code
         self._lang = lang
         self._quote = quote
-        self._backticks = 3
+        if self._code:
+            warnings.warn("code block feature of Paragraph is a duplicate of the Code class")
 
     @staticmethod
     def _process_content(content) -> None:

snakemd/templates.py

@@ -1,7 +1,5 @@
 from __future__ import annotations
 
-from typing import Iterable
-
 from .elements import Element, Heading, Inline, MDList, Verification