Actually add the docs

docs/api/ffmddb.client.rst

@@ -0,0 +1,7 @@
+ffmddb.client module
+====================
+
+.. automodule:: ffmddb.client
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/api/ffmddb.core.database.rst

@@ -0,0 +1,7 @@
+ffmddb.core.database module
+===========================
+
+.. automodule:: ffmddb.core.database
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/api/ffmddb.core.models.config.rst

@@ -0,0 +1,7 @@
+ffmddb.core.models.config module
+================================
+
+.. automodule:: ffmddb.core.models.config
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/api/ffmddb.core.models.document.rst

@@ -0,0 +1,7 @@
+ffmddb.core.models.document module
+==================================
+
+.. automodule:: ffmddb.core.models.document
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/api/ffmddb.core.models.field.rst

@@ -0,0 +1,7 @@
+ffmddb.core.models.field module
+===============================
+
+.. automodule:: ffmddb.core.models.field
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/api/ffmddb.core.models.index.rst

@@ -0,0 +1,7 @@
+ffmddb.core.models.index module
+===============================
+
+.. automodule:: ffmddb.core.models.index
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/api/ffmddb.core.models.query.rst

@@ -0,0 +1,7 @@
+ffmddb.core.models.query module
+===============================
+
+.. automodule:: ffmddb.core.models.query
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/api/ffmddb.core.models.rst

@@ -0,0 +1,19 @@
+ffmddb.core.models package
+==========================
+
+.. automodule:: ffmddb.core.models
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+
+   ffmddb.core.models.config
+   ffmddb.core.models.document
+   ffmddb.core.models.field
+   ffmddb.core.models.index
+   ffmddb.core.models.query
+

docs/api/ffmddb.core.rst

@@ -0,0 +1,22 @@
+ffmddb.core package
+===================
+
+.. automodule:: ffmddb.core
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+
+    ffmddb.core.models
+
+Submodules
+----------
+
+.. toctree::
+
+   ffmddb.core.database
+

docs/api/ffmddb.rst

@@ -0,0 +1,23 @@
+ffmddb package
+==============
+
+.. automodule:: ffmddb
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+
+    ffmddb.core
+
+Submodules
+----------
+
+.. toctree::
+
+   ffmddb.client
+   ffmddb.server
+

docs/api/ffmddb.server.rst

@@ -0,0 +1,7 @@
+ffmddb.server module
+====================
+
+.. automodule:: ffmddb.server
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/api/index.rst

@@ -0,0 +1,7 @@
+ffmddb
+======
+
+.. toctree::
+   :maxdepth: 4
+
+   ffmddb

docs/conf.py

@@ -0,0 +1,176 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# ffmddb documentation build configuration file, created by
+# sphinx-quickstart on Wed Feb  1 11:47:50 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# 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('.'))
+
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# 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',
+    'sphinx.ext.todo',
+    'sphinx.ext.coverage',
+    'sphinx.ext.ifconfig',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.githubpages']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['.sphinx-templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'ffmddb'
+copyright = '2017, Madison Scott-Clary'
+author = 'Madison Scott-Clary'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.0.0'
+# The full version, including alpha/beta/rc tags.
+release = 'pre-release'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['.sphinx-build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
+
+
+# -- 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'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+html_theme_options = {
+    'logo_name': True,
+    'github_user': 'makyo',
+    'github_repo': 'ffmddb',
+    'github_button': False,
+    'github_banner': True,
+    'description': 'A flat-file-with-metadata database.',
+}
+
+html_sidebars = {
+    '**': [
+        'about.html',
+        'navigation.html',
+        'relations.html',
+        'searchbox.html',
+        'donate.html',
+    ]
+}
+
+# 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 = ['.sphinx-static']
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'ffmddbdoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'ffmddb.tex', 'ffmddb Documentation',
+     'Madison Scott-Clary', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'ffmddb', 'ffmddb Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'ffmddb', 'ffmddb Documentation',
+     author, 'ffmddb', 'One line description of project.',
+     'Miscellaneous'),
+]

docs/index.rst

@@ -0,0 +1,27 @@
+.. ffmddb documentation master file, created by
+   sphinx-quickstart on Wed Feb  1 11:47:50 2017.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+ffmddb Documentation
+====================
+
+A flat-file-with-metadata database.
+
+.. image:: https://travis-ci.org/makyo/ffmddb.svg?branch=master
+    :target: https://travis-ci.org/makyo/ffmddb
+.. image:: https://coveralls.io/repos/github/makyo/ffmddb/badge.svg?branch=master
+    :target: https://coveralls.io/github/makyo/ffmddb?branch=master
+
+
+This is a reference implementation for a simple document database idea based on flat-files, each of which contains at least one field (a large text blob, the document field) and potentially many other fields formed of structured data contained in a metadata blob within the file.
+
+In short, it turns files written in a Jekyll fashion into objects in a database. The 'post content' turns into the document field, and the metadata blob turns into other fields. Indices are built and querying becomes possible within the indices (full document querying should rely on something like elasticsearch).
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Contents:
+
+   usage
+   API <api/index>
+   use-case

docs/usage.rst

@@ -0,0 +1,8 @@
+Using ffmddb
+============
+
+The ffmddb shell
+----------------
+
+The ffmddb API
+--------------

docs/use-case.rst

@@ -0,0 +1,2 @@
+ffmddb Use Case Scenario
+========================