Add documentation

.gitignore

@@ -154,3 +154,4 @@ wbia_orientation/__pycache__/*
 draws/
 plot/
 timeings.txt
+docs/

_docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = wbia_orientation
+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,69 @@
+# -*- coding: utf-8 -*-
+from sphinx.ext.autodoc import between
+import sphinx_rtd_theme  # NOQA
+import sys
+import os
+
+# Dont parse IBEIS args
+os.environ['IBIES_PARSE_ARGS'] = 'OFF'
+os.environ['UTOOL_AUTOGEN_SPHINX_RUNNING'] = 'ON'
+
+sys.path.append(os.path.abspath('../'))
+
+autosummary_generate = True
+
+modindex_common_prefix = ['_']
+# -*- 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/stable/config
+
+master_doc = 'index'
+
+html_theme = 'sphinx_rtd_theme'
+html_theme_path = [
+    '_themes',
+]
+
+# -- Project information -----------------------------------------------------
+
+project = 'wbia_orientation'
+copyright = '2019, Wild Me'
+author = 'Olga Moskvyak, Jason Parham'
+
+# The short X.Y version
+version = '0.1.0.dev0'
+
+# The full version, including alpha/beta/rc tags
+release = '0.1.0.dev0'
+
+
+# -- 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',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.imgmath',
+    'sphinx.ext.napoleon',
+]
+
+
+# -- Extension configuration -------------------------------------------------
+
+# -- Options for todo extension ----------------------------------------------
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+def setup(app):
+    # Register a sphinx.ext.autodoc.between listener to ignore everything
+    # between lines that contain the word IGNORE
+    app.connect('autodoc-process-docstring', between('^.*IGNORE.*$', exclude=True))
+    return app

_docs/index.rst

@@ -0,0 +1,21 @@
+.. wbia_orientation documentation master file, created by
+   sphinx-quickstart on Wed Aug 15 11:40:25 2018.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to WBIA Orientation Plug-in documentation!
+==================================================
+
+.. toctree::
+   :maxdepth: 8
+   :caption: Contents:
+
+   wbia_orientation
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

_docs/wbia_orientation.rst

@@ -0,0 +1,21 @@
+wbia\_orientation package
+=========================
+
+Submodules
+----------
+
+wbia\_orientation.\_plugin module
+---------------------------------
+
+.. automodule:: wbia_orientation._plugin
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: wbia_orientation
+    :members:
+    :undoc-members:
+    :show-inheritance:

setup.py

@@ -176,6 +176,7 @@ def gen_packages_items():
 
 AUTHORS = [
     'Olga Moskvyak',
+    'Jason Parham',
 ]
 AUTHOR_EMAIL = '[email protected]'
 URL = 'https://github.com/WildbookOrg/wbia-plugin-orientation'