From d6dfa154901b5228d23739b5e1339518d3c869e0 Mon Sep 17 00:00:00 2001
From: Brandon Rodriguez <brodriguez8774@gmail.com>
Date: Fri, 30 Sep 2022 14:03:04 -0400
Subject: [PATCH] Add initial templating for intended future documentation

---
 docs/source/conf.py                           |  2 +-
 docs/source/index.rst                         |  8 +++++
 .../supplementary/mysql_syntax_docs.rst       | 36 +++++++++++++++++++
 .../supplementary/postgresql_syntax_docs.rst  | 33 +++++++++++++++++
 .../supplementary/sqlite_syntax_docs.rst      | 11 ++++++
 py_dbcn/constants.py                          |  1 +
 6 files changed, 90 insertions(+), 1 deletion(-)
 create mode 100644 docs/source/supplementary/mysql_syntax_docs.rst
 create mode 100644 docs/source/supplementary/postgresql_syntax_docs.rst
 create mode 100644 docs/source/supplementary/sqlite_syntax_docs.rst

diff --git a/docs/source/conf.py b/docs/source/conf.py
index 2703c42..5f3e5cf 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -17,7 +17,7 @@ sys.path.insert(0, os.path.abspath('../..'))
 
 # -- Project information -----------------------------------------------------
 
-project = 'py-dbcn'
+project = 'Pythonic Database Connector'
 copyright = '2022, Brandon Rodriguez'
 author = 'Brandon Rodriguez'
 
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 02eaa03..ce5f9ec 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -42,6 +42,14 @@ the way.
    roadmap
    version_history
 
+.. toctree::
+   :maxdepth: 1
+   :caption: Supplementary Documentation
+
+   supplementary/sqlite_syntax_docs
+   supplementary/mysql_syntax_docs
+   supplementary/postgresql_syntax_docs
+
 
 Indices and tables
 ==================
diff --git a/docs/source/supplementary/mysql_syntax_docs.rst b/docs/source/supplementary/mysql_syntax_docs.rst
new file mode 100644
index 0000000..b2e984b
--- /dev/null
+++ b/docs/source/supplementary/mysql_syntax_docs.rst
@@ -0,0 +1,36 @@
+MySQL Syntax
+************
+
+Here is supplementary documentation of basic `MySQL <https://www.mysql.com/>`_
+syntax, to help with using the ``py-dbcn`` package.
+
+
+Quote Formatting
+================
+While not strictly necessary for the ``py-dbcn`` package, we document the
+expected quote formatting types here:
+
+* ````` - Column Quote Format - Used for quoting around table column names.
+* ````` - Identifier Quote Format - Used for quoting around identifiers, such
+  as SELECT clause field id's.
+* ``"`` - Str Literal Quote Format - Used for quoting around literal strings.
+
+
+Clause Formatting
+=================
+
+
+Database Query Formatting
+=========================
+
+
+Table Query Formatting
+======================
+
+
+Record Query Formatting
+=======================
+
+
+See also:
+https://sphinx-tabs.readthedocs.io/en/latest/
diff --git a/docs/source/supplementary/postgresql_syntax_docs.rst b/docs/source/supplementary/postgresql_syntax_docs.rst
new file mode 100644
index 0000000..1c01aa3
--- /dev/null
+++ b/docs/source/supplementary/postgresql_syntax_docs.rst
@@ -0,0 +1,33 @@
+PostgreSQL Syntax
+*****************
+
+Here is supplementary documentation of basic
+`PostgreSQL <https://www.postgresql.org/>`_ syntax, to help with using the
+``py-dbcn`` package.
+
+
+Quote Formatting
+================
+While not strictly necessary for the ``py-dbcn`` package, we document the
+expected quote formatting types here:
+
+* ``'`` - Column Quote Format - Used for quoting around table column names.
+* ``"`` - Identifier Quote Format - Used for quoting around identifiers, such
+  as SELECT clause field id's.
+* ``'`` - Str Literal Quote Format - Used for quoting around literal strings.
+
+
+Clause Formatting
+=================
+
+
+Database Query Formatting
+=========================
+
+
+Table Query Formatting
+======================
+
+
+Record Query Formatting
+=======================
diff --git a/docs/source/supplementary/sqlite_syntax_docs.rst b/docs/source/supplementary/sqlite_syntax_docs.rst
new file mode 100644
index 0000000..0f43bba
--- /dev/null
+++ b/docs/source/supplementary/sqlite_syntax_docs.rst
@@ -0,0 +1,11 @@
+SqLite Syntax
+*************
+
+Here is supplementary documentation of basic
+`SqLite <https://www.sqlite.org/>`_ syntax, to help with using the
+``py-dbcn`` package.
+
+
+.. warning::
+
+    SqLite support not yet implemented.
diff --git a/py_dbcn/constants.py b/py_dbcn/constants.py
index 3c36cd3..1bf5306 100644
--- a/py_dbcn/constants.py
+++ b/py_dbcn/constants.py
@@ -27,6 +27,7 @@ try:
 except ImportError:
     PYTZ_PRESENT = False
 
+
 # Color output imports.
 try:
     from colorama import Back, Fore, Style
-- 
GitLab