Reworked Sphinx Documentation (#8)

* Regenerated docs

* Updated documentation again

* Fixed version

* Reworked folder setup

* Updated makefile

.gitignore

@@ -65,7 +65,7 @@ instance/
 .scrapy
 
 # Sphinx documentation
-docs/_build/
+docsrc/_build/
 
 # PyBuilder
 target/

docs/html/.buildinfo → docs/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 73d65bea6f6abda8a3dc9dbd625a01f4
+config: b5101cc7847df573f43ec8b3aac1c195
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/html/_sources/index.rst.txt → docs/_sources/index.rst.txt

@@ -1,18 +1,20 @@
-.. PyMD documentation master file, created by
-   sphinx-quickstart on Wed Jul 14 20:23:26 2021.
+.. 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 PyMD's documentation!
-================================
+Welcome to SnakeMD's documentation!
+===================================
+
+SnakeMD is a library for generating markdown files
+using Python
 
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
    modules
 
-
 Indices and tables
 ==================
 

docs/html/_sources/modules.rst.txt → docs/_sources/modules.rst.txt

@@ -1,7 +1,7 @@
-pymd
-====
+snakemd
+=======
 
 .. toctree::
    :maxdepth: 4
 
-   pymd
+   snakemd

docs/html/_sources/pymd.rst.txt → docs/_sources/snakemd.rst.txt

@@ -1,29 +1,29 @@
-pymd package
-============
+snakemd package
+===============
 
 Submodules
 ----------
 
-pymd.markdown module
---------------------
+snakemd.markdown module
+-----------------------
 
-.. automodule:: pymd.markdown
+.. automodule:: snakemd.markdown
    :members:
    :undoc-members:
    :show-inheritance:
 
-pymd.readme module
-------------------
+snakemd.readme module
+---------------------
 
-.. automodule:: pymd.readme
+.. automodule:: snakemd.readme
    :members:
    :undoc-members:
    :show-inheritance:
 
 Module contents
 ---------------
 
-.. automodule:: pymd
+.. automodule:: snakemd
    :members:
    :undoc-members:
    :show-inheritance:

docs/html/genindex.html → docs/genindex.html

@@ -7,7 +7,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
-  <title>Index &mdash; PyMD 1.0.0 documentation</title>
+  <title>Index &mdash; SnakeMD 1.0.0 documentation</title>
 
 
 
@@ -54,7 +54,7 @@
 
 
 
-            <a href="index.html" class="icon icon-home"> PyMD
+            <a href="index.html" class="icon icon-home"> SnakeMD
 
 
 
@@ -87,7 +87,7 @@
 
               <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="modules.html">pymd</a></li>
+<li class="toctree-l1"><a class="reference internal" href="modules.html">snakemd</a></li>
 </ul>
 
 
@@ -103,7 +103,7 @@
       <nav class="wy-nav-top" aria-label="top navigation">
 
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-          <a href="index.html">PyMD</a>
+          <a href="index.html">SnakeMD</a>
 
       </nav>
 
@@ -176,91 +176,91 @@ <h1 id="index">Index</h1>
 <h2 id="A">A</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="pymd.html#pymd.markdown.Paragraph.add">add() (pymd.markdown.Paragraph method)</a>
+      <li><a href="snakemd.html#snakemd.markdown.Paragraph.add">add() (snakemd.markdown.Paragraph method)</a>
 </li>
-      <li><a href="pymd.html#pymd.markdown.Document.add_code">add_code() (pymd.markdown.Document method)</a>
+      <li><a href="snakemd.html#snakemd.markdown.Document.add_code">add_code() (snakemd.markdown.Document method)</a>
 </li>
-      <li><a href="pymd.html#pymd.markdown.Document.add_element">add_element() (pymd.markdown.Document method)</a>
+      <li><a href="snakemd.html#snakemd.markdown.Document.add_element">add_element() (snakemd.markdown.Document method)</a>
 </li>
-      <li><a href="pymd.html#pymd.markdown.Document.add_header">add_header() (pymd.markdown.Document method)</a>
+      <li><a href="snakemd.html#snakemd.markdown.Document.add_header">add_header() (snakemd.markdown.Document method)</a>
 </li>
-      <li><a href="pymd.html#pymd.markdown.Document.add_ordered_list">add_ordered_list() (pymd.markdown.Document method)</a>
+      <li><a href="snakemd.html#snakemd.markdown.Document.add_ordered_list">add_ordered_list() (snakemd.markdown.Document method)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="pymd.html#pymd.markdown.Document.add_paragraph">add_paragraph() (pymd.markdown.Document method)</a>
+      <li><a href="snakemd.html#snakemd.markdown.Document.add_paragraph">add_paragraph() (snakemd.markdown.Document method)</a>
 </li>
-      <li><a href="pymd.html#pymd.markdown.Document.add_quote">add_quote() (pymd.markdown.Document method)</a>
+      <li><a href="snakemd.html#snakemd.markdown.Document.add_quote">add_quote() (snakemd.markdown.Document method)</a>
 </li>
-      <li><a href="pymd.html#pymd.markdown.Document.add_table">add_table() (pymd.markdown.Document method)</a>
+      <li><a href="snakemd.html#snakemd.markdown.Document.add_table">add_table() (snakemd.markdown.Document method)</a>
 </li>
-      <li><a href="pymd.html#pymd.markdown.Document.add_table_of_contents">add_table_of_contents() (pymd.markdown.Document method)</a>
+      <li><a href="snakemd.html#snakemd.markdown.Document.add_table_of_contents">add_table_of_contents() (snakemd.markdown.Document method)</a>
 </li>
-      <li><a href="pymd.html#pymd.markdown.Document.add_unordered_list">add_unordered_list() (pymd.markdown.Document method)</a>
+      <li><a href="snakemd.html#snakemd.markdown.Document.add_unordered_list">add_unordered_list() (snakemd.markdown.Document method)</a>
 </li>
   </ul></td>
 </tr></table>
 
 <h2 id="B">B</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="pymd.html#pymd.markdown.InlineText.bold">bold() (pymd.markdown.InlineText method)</a>
+      <li><a href="snakemd.html#snakemd.markdown.InlineText.bold">bold() (snakemd.markdown.InlineText method)</a>
 </li>
   </ul></td>
 </tr></table>
 
 <h2 id="D">D</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="pymd.html#pymd.markdown.Header.demote">demote() (pymd.markdown.Header method)</a>
+      <li><a href="snakemd.html#snakemd.markdown.Header.demote">demote() (snakemd.markdown.Header method)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="pymd.html#pymd.markdown.Document">Document (class in pymd.markdown)</a>
+      <li><a href="snakemd.html#snakemd.markdown.Document">Document (class in snakemd.markdown)</a>
 </li>
   </ul></td>
 </tr></table>
 
 <h2 id="E">E</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="pymd.html#pymd.markdown.Element">Element (class in pymd.markdown)</a>
+      <li><a href="snakemd.html#snakemd.markdown.Element">Element (class in snakemd.markdown)</a>
 </li>
   </ul></td>
 </tr></table>
 
 <h2 id="H">H</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="pymd.html#pymd.markdown.Header">Header (class in pymd.markdown)</a>
+      <li><a href="snakemd.html#snakemd.markdown.Header">Header (class in snakemd.markdown)</a>
 </li>
   </ul></td>
 </tr></table>
 
 <h2 id="I">I</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="pymd.html#pymd.markdown.InlineText">InlineText (class in pymd.markdown)</a>
+      <li><a href="snakemd.html#snakemd.markdown.InlineText">InlineText (class in snakemd.markdown)</a>
 </li>
   </ul></td>
 </tr></table>
 
 <h2 id="M">M</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="pymd.html#pymd.readme.main">main() (in module pymd.readme)</a>
+      <li><a href="snakemd.html#snakemd.readme.main">main() (in module snakemd.readme)</a>
 </li>
-      <li><a href="pymd.html#pymd.markdown.MDList">MDList (class in pymd.markdown)</a>
+      <li><a href="snakemd.html#snakemd.markdown.MDList">MDList (class in snakemd.markdown)</a>
 </li>
       <li>
     module
 
       <ul>
-        <li><a href="pymd.html#module-pymd">pymd</a>
+        <li><a href="snakemd.html#module-snakemd">snakemd</a>
 </li>
-        <li><a href="pymd.html#module-pymd.markdown">pymd.markdown</a>
+        <li><a href="snakemd.html#module-snakemd.markdown">snakemd.markdown</a>
 </li>
-        <li><a href="pymd.html#module-pymd.readme">pymd.readme</a>
+        <li><a href="snakemd.html#module-snakemd.readme">snakemd.readme</a>
 </li>
       </ul></li>
   </ul></td>
@@ -269,61 +269,40 @@ <h2 id="M">M</h2>
 <h2 id="O">O</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="pymd.html#pymd.markdown.Document.output_page">output_page() (pymd.markdown.Document method)</a>
+      <li><a href="snakemd.html#snakemd.markdown.Document.output_page">output_page() (snakemd.markdown.Document method)</a>
 </li>
   </ul></td>
 </tr></table>
 
 <h2 id="P">P</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="pymd.html#pymd.markdown.Paragraph">Paragraph (class in pymd.markdown)</a>
+      <li><a href="snakemd.html#snakemd.markdown.Paragraph">Paragraph (class in snakemd.markdown)</a>
 </li>
-      <li><a href="pymd.html#pymd.markdown.Header.promote">promote() (pymd.markdown.Header method)</a>
-</li>
-      <li>
-    pymd
-
-      <ul>
-        <li><a href="pymd.html#module-pymd">module</a>
-</li>
-      </ul></li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li>
-    pymd.markdown
-
-      <ul>
-        <li><a href="pymd.html#module-pymd.markdown">module</a>
-</li>
-      </ul></li>
-      <li>
-    pymd.readme
-
-      <ul>
-        <li><a href="pymd.html#module-pymd.readme">module</a>
+      <li><a href="snakemd.html#snakemd.markdown.Header.promote">promote() (snakemd.markdown.Header method)</a>
 </li>
-      </ul></li>
   </ul></td>
 </tr></table>
 
 <h2 id="R">R</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="pymd.html#pymd.markdown.Document.render">render() (pymd.markdown.Document method)</a>
+      <li><a href="snakemd.html#snakemd.markdown.Document.render">render() (snakemd.markdown.Document method)</a>
 
       <ul>
-        <li><a href="pymd.html#pymd.markdown.Element.render">(pymd.markdown.Element method)</a>
+        <li><a href="snakemd.html#snakemd.markdown.Element.render">(snakemd.markdown.Element method)</a>
 </li>
-        <li><a href="pymd.html#pymd.markdown.Header.render">(pymd.markdown.Header method)</a>
+        <li><a href="snakemd.html#snakemd.markdown.Header.render">(snakemd.markdown.Header method)</a>
 </li>
-        <li><a href="pymd.html#pymd.markdown.InlineText.render">(pymd.markdown.InlineText method)</a>
+        <li><a href="snakemd.html#snakemd.markdown.InlineText.render">(snakemd.markdown.InlineText method)</a>
 </li>
-        <li><a href="pymd.html#pymd.markdown.MDList.render">(pymd.markdown.MDList method)</a>
+        <li><a href="snakemd.html#snakemd.markdown.MDList.render">(snakemd.markdown.MDList method)</a>
 </li>
-        <li><a href="pymd.html#pymd.markdown.Paragraph.render">(pymd.markdown.Paragraph method)</a>
+        <li><a href="snakemd.html#snakemd.markdown.Paragraph.render">(snakemd.markdown.Paragraph method)</a>
 </li>
-        <li><a href="pymd.html#pymd.markdown.Table.render">(pymd.markdown.Table method)</a>
+        <li><a href="snakemd.html#snakemd.markdown.Table.render">(snakemd.markdown.Table method)</a>
 </li>
       </ul></li>
   </ul></td>
@@ -332,36 +311,59 @@ <h2 id="R">R</h2>
 <h2 id="S">S</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="pymd.html#pymd.markdown.Document.scramble">scramble() (pymd.markdown.Document method)</a>
+      <li><a href="snakemd.html#snakemd.markdown.Document.scramble">scramble() (snakemd.markdown.Document method)</a>
+</li>
+      <li>
+    snakemd
+
+      <ul>
+        <li><a href="snakemd.html#module-snakemd">module</a>
+</li>
+      </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li>
+    snakemd.markdown
+
+      <ul>
+        <li><a href="snakemd.html#module-snakemd.markdown">module</a>
+</li>
+      </ul></li>
+      <li>
+    snakemd.readme
+
+      <ul>
+        <li><a href="snakemd.html#module-snakemd.readme">module</a>
 </li>
+      </ul></li>
   </ul></td>
 </tr></table>
 
 <h2 id="T">T</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="pymd.html#pymd.markdown.Table">Table (class in pymd.markdown)</a>
+      <li><a href="snakemd.html#snakemd.markdown.Table">Table (class in snakemd.markdown)</a>
 </li>
   </ul></td>
 </tr></table>
 
 <h2 id="U">U</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="pymd.html#pymd.markdown.InlineText.unbold">unbold() (pymd.markdown.InlineText method)</a>
+      <li><a href="snakemd.html#snakemd.markdown.InlineText.unbold">unbold() (snakemd.markdown.InlineText method)</a>
 </li>
   </ul></td>
 </tr></table>
 
 <h2 id="V">V</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="pymd.html#pymd.markdown.Element.verify">verify() (pymd.markdown.Element method)</a>
+      <li><a href="snakemd.html#snakemd.markdown.Element.verify">verify() (snakemd.markdown.Element method)</a>
 
       <ul>
-        <li><a href="pymd.html#pymd.markdown.InlineText.verify">(pymd.markdown.InlineText method)</a>
+        <li><a href="snakemd.html#snakemd.markdown.InlineText.verify">(snakemd.markdown.InlineText method)</a>
 </li>
-        <li><a href="pymd.html#pymd.markdown.Table.verify">(pymd.markdown.Table method)</a>
+        <li><a href="snakemd.html#snakemd.markdown.Table.verify">(snakemd.markdown.Table method)</a>
 </li>
       </ul></li>
   </ul></td>