Finalized Version History for 0.13.0 (#82)

* Added version history

* Renamed snake file to docs

* Cleaned up docs page

docs/snake.rst → docs/docs.rst

@@ -22,9 +22,9 @@ The SnakeMD Document
 For the average user, the document object is the only
 object in the library necessary to create markdown files.
 Document objects are automatically created from the
-:code:`new_doc()` function of the SnakeMD module.
+:func:`new_doc()` function of the SnakeMD module.
 
-.. autoclass:: snakemd.generator.Document
+.. autoclass:: snakemd.Document
    :members:
    :undoc-members:
    :show-inheritance:
@@ -36,11 +36,11 @@ For users who want a little more control over how
 their markdown is formatted, SnakeMD provides, 
 a variety of markdown elements which you can create 
 and add to an existing document using the 
-:code:`add_element()` method. Elements all inherit 
-from the :code:`Element` "interface" which is defined 
+:func:`add_element()` method. Elements all inherit 
+from the :class:`Element` "interface" which is defined 
 as follows:
 
-.. autoclass:: snakemd.generator.Element
+.. autoclass:: snakemd.Element
    :members:
    :undoc-members:
    :show-inheritance:
@@ -49,11 +49,11 @@ Because of the increase in control granted to you
 by elements, there are opportunities where invalid
 markdown can be generated. In an attempt to provide
 a method of verifying the structure of the markdown,
-a :code:`verify()`` method has been provided for all 
-elements. The result of a call to :code:`verify`
+a :func:`verify()`` method has been provided for all 
+elements. The result of a call to :func:`verify`
 is a verification object which is defined as folows:
 
-.. autoclass:: snakemd.generator.Verification
+.. autoclass:: snakemd.Verification
    :members:
    :undoc-members:
    :show-inheritance:
@@ -64,79 +64,79 @@ elements that can be added to a markdown document.
 CheckBox
 ^^^^^^^^^^^^^^^^^^^
 
-.. autoclass:: snakemd.generator.CheckBox
+.. autoclass:: snakemd.CheckBox
    :members:
    :undoc-members:
    :show-inheritance:
 
 Header
 ^^^^^^^^^^^^^^^^^^^
 
-.. autoclass:: snakemd.generator.Header
+.. autoclass:: snakemd.Header
    :members:
    :undoc-members:
    :show-inheritance:
 
 Heading
 ^^^^^^^^^^^^^^^^^^^
 
-.. autoclass:: snakemd.generator.Heading
+.. autoclass:: snakemd.Heading
    :members:
    :undoc-members:
    :show-inheritance:
 
 HorizontalRule
 ^^^^^^^^^^^^^^^^^^^
 
-.. autoclass:: snakemd.generator.HorizontalRule
+.. autoclass:: snakemd.HorizontalRule
    :members:
    :undoc-members:
    :show-inheritance:
 
 InlineText
 ^^^^^^^^^^^^^^^^^^^
 
-.. autoclass:: snakemd.generator.InlineText
+.. autoclass:: snakemd.InlineText
    :members:
    :undoc-members:
    :show-inheritance:
 
 MDCheckList
 ^^^^^^^^^^^^^^^^^^^
 
-.. autoclass:: snakemd.generator.MDCheckList
+.. autoclass:: snakemd.MDCheckList
    :members:
    :undoc-members:
    :show-inheritance:
 
 MDList
 ^^^^^^^^^^^^^^^^^^^
 
-.. autoclass:: snakemd.generator.MDList
+.. autoclass:: snakemd.MDList
    :members:
    :undoc-members:
    :show-inheritance:
 
 Paragraph
 ^^^^^^^^^^^^^^^^^^^
 
-.. autoclass:: snakemd.generator.Paragraph
+.. autoclass:: snakemd.Paragraph
    :members:
    :undoc-members:
    :show-inheritance:
 
 Table
 ^^^^^^^^^^^^^^^^^^^
 
-.. autoclass:: snakemd.generator.Table
+.. autoclass:: snakemd.Table
    :members:
    :undoc-members:
    :show-inheritance:
 
 TableOfContents
 ^^^^^^^^^^^^^^^^^^^
 
-.. autoclass:: snakemd.generator.TableOfContents
+.. autoclass:: snakemd.TableOfContents
    :members:
    :undoc-members:
    :show-inheritance:

docs/index.rst

@@ -1,8 +1,3 @@
-.. SnakeMD documentation master file, created by
-   sphinx-quickstart on Thu Jul 15 16:04:57 2021.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
 Welcome to SnakeMD's Documentation!
 ===================================
 
@@ -14,5 +9,5 @@ using Python. Use the links below to navigate the docs.
 
    install
    usage
-   snake
+   docs
    version-history

docs/version-history.rst

@@ -10,6 +10,11 @@ In an effort to keep history of all the documentation
 for SnakeMD, we've included all old versions below
 as follows:
 
+* v0.13.0 [:pr:`71`, :pr:`74`, :pr:`76`, :pr:`78`, :pr:`80`, :pr:`82`]
+    * Created a replacement method for output_page called dump
+    * Renamed Header class to Heading
+    * Included deprecation warnings for both output_page and header as well as others affected
+
 * v0.12.0 [:pr:`65`, :pr:`66`]
     * Added support for table generation on-the-fly (:issue:`64`)
     * Reworked documentation to include proper headings and organization