Add sphinx docs

.circleci/config.yml

@@ -27,3 +27,27 @@ jobs:
             sudo pip install .
             python -m unittest discover -v -s test/integration
 
+      - add_ssh_keys:
+          fingerprints:
+            - "79:16:39:74:e9:b3:39:52:87:2c:90:aa:ee:3c:09:13"
+
+      - run:
+          name: Deploy documentation
+          command: |
+            if [ "${CIRCLE_BRANCH}" == "${PRODUCTION_BRANCH}" ]; then
+              cd docs
+              make html
+              cd _build/html
+              git init
+              git config user.name "Devseed-CI"
+              git config user.email "dev@developmentseed.org"
+              touch .nojekyll # Add this so GitHub doesn't try and build site
+              git add .
+              git commit -m "CI deploy [skip ci]"
+              git remote add origin git@github.com:developmentseed/label-maker.git
+              git fetch
+              git push origin --force --quiet HEAD:gh-pages
+              rm -rf .git
+            else
+              echo "Not the branch you're looking for, skipping documentation deploy"
+            fi

.gitignore

@@ -13,3 +13,4 @@ config.json
 stdout*
 /integration*
 .idea/
+docs/_build/

docs/Makefile

@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = .
+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/conf.py

@@ -0,0 +1,182 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- 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('.'))
+sys.path.insert(0, os.path.abspath('../label_maker'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'label-maker'
+copyright = '2018, Development Seed'
+author = 'Development Seed'
+
+# The short X.Y version
+version = '0.3.2'
+# The full version, including alpha/beta/rc tags
+release = '0.3.2'
+
+
+# -- 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.viewcode',
+    'sphinx.ext.napoleon',
+    'sphinx.ext.githubpages',
+    'sphinxcontrib.fulltoc'
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_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'
+
+# 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 pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = None
+
+
+# -- 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 = {}
+
+# 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']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'label-makerdoc'
+
+
+# -- 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, 'label-maker.tex', 'label-maker Documentation',
+     'Development Seed', '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, 'label-maker', 'label-maker 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, 'label-maker', 'label-maker Documentation',
+     author, 'label-maker', 'Data preparation for machine learning on overhead imagery.',
+     'Miscellaneous'),
+]
+
+
+# -- Options for Epub output -------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#
+# epub_identifier = ''
+
+# A unique identification for the text.
+#
+# epub_uid = ''
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+
+# -- Extension configuration -------------------------------------------------

docs/contributing.rst

@@ -0,0 +1,32 @@
+Contributing
+============
+
+A list of issues and ongoing work is available on the Label Maker `issues page <https://github.com/developmentseed/label-maker/issues>`_. If you want to contribute code, the best way is to coordinate with the core developers via an issue or pull request conversation.
+
+Development installation
+^^^^^^^^^^^^^^^^^^^^^^^^
+Fork Label Maker into your Github account. Then, clone the repo and install it locally with pip as follows:
+
+.. code-block:: bash
+
+	$ git clone git@github.com:your_user_name/label-maker.git
+	$ cd  label-maker
+	$ pip install -e .
+
+Testing
+^^^^^^^
+Label Maker runs tests using ``unittest``. You can find unit tests at ``tests/unit`` and integration tests at ``tests/integration``.
+
+Run a single test with:
+
+.. code-block:: bash
+
+	python -m unittest test/unit/test_validate.py
+
+or an entire folder using:
+
+.. code-block:: bash
+
+	python -m unittest discover -v -s test/unit
+
+More details on using ``unittest`` are `here <https://docs.python.org/3/library/unittest.html>`_.

docs/examples.rst

@@ -0,0 +1,6 @@
+Examples
+########
+
+Examples live `here <https://github.com/developmentseed/label-maker/tree/master/examples>`_
+
+ToDo: move these to their own page within this docs website.