Merge pull request #16 from jedymatt/add-docs

Initialize docs

Author: jedymatt

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/environment.yaml

@@ -0,0 +1,7 @@
+name: docs
+channels:
+    - defaults
+dependencies:
+    - sphinx==4.2.0
+    - pip:
+          - sphinx_rtd_theme

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/requirements.txt

@@ -0,0 +1,2 @@
+sphinx-rtd-theme==1.0.0
+sphinx==4.2.0

docs/source/api.rst

@@ -0,0 +1,40 @@
+.. currentmodule:: sqlalchemyseed
+
+API Reference
+=============
+
+Seeders
+--------------
+
+.. autoclass:: seeder.Seeder
+    :members:
+    :undoc-members:
+
+.. autoclass:: seeder.HybridSeeder
+    :members:
+    :undoc-members:
+
+Loaders
+-------
+
+.. automodule:: loader
+    :members:
+    :undoc-members:
+
+Validators
+----------
+
+.. autoclass:: validator.SchemaValidator
+    :members:
+
+.. autofunction:: validator.validate
+
+
+.. autofunction:: validator.hybrid_validate 
+    
+
+Exceptions
+----------
+
+.. automodule:: errors
+    :members:

docs/source/conf.py

@@ -0,0 +1,54 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'sqlalchemyseed'
+copyright = '2021, jedymatt'
+author = 'jedymatt'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autodoc'
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+# html_theme = "alabaster"
+html_theme = "sphinx_rtd_theme"
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']

docs/source/index.rst

@@ -0,0 +1,26 @@
+.. sqlalchemyseed documentation master file, created by
+   sphinx-quickstart on Sat Sep 25 14:41:54 2021.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to sqlalchemyseed's documentation!
+==========================================
+
+sqlalchemyseed is a SQLAlchemy seeder that supports nested relationships
+with an easy to read text files.
+
+Contents
+========
+
+.. toctree::
+    :maxdepth: 2
+    
+    intro
+    api
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/source/intro.rst

@@ -0,0 +1,42 @@
+Introduction
+============
+
+sqlalchemyseed is a SQLAlchemy seeder that supports nested relationships
+with an easy to read text files.
+
+Supported file types.
+
+- json
+- yaml
+- csv
+
+Example of json file
+
+.. code-block :: json
+
+    {
+        "model": "models.Person",
+        "data": [
+            {
+                "name": "John March",
+                "age": 23
+            },
+            {
+                "name": "Juan Dela Cruz",
+                "age": 21
+            }
+        ]
+    }
+
+
+Installation
+------------
+
+Default installation ::
+
+    pip install sqlalchemyseed
+
+When using yaml to load entities from yaml files,
+execute this command to install necessary dependencies ::
+
+    pip install sqlalchemyseed[yaml]