Merge pull request #9 from numberly/feature/documentation

Add documentation

.gitignore

@@ -55,4 +55,7 @@ Session.vim
 
 # virtualenv
 .venv*
-src/
+src/
+
+# docs
+docs/_build

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    = Thingy
+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,38 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+
+# 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 ------------------------------------------------
+
+# 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",
+]
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'Thingy'
+copyright = 'numberly'
+author = 'numberly'
+
+
+# -- 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'

docs/index.rst

@@ -0,0 +1,14 @@
+.. Thingy documentation master file, created by
+   sphinx-quickstart on Thu Mar 29 15:01:49 2018.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+.. include:: ../README.rst
+
+Documentation
+=============
+
+.. toctree::
+   :maxdepth: 1
+
+   reference

docs/reference.rst

@@ -0,0 +1,6 @@
+API reference
+#############
+
+.. automodule:: thingy
+    :members:
+    :undoc-members:

requirements.txt

@@ -1,3 +1,4 @@
 pytest==3.0.7
 pytest-cov==2.4.0
 six==1.10.0
+sphinx==1.7.2

thingy.py

@@ -22,6 +22,13 @@ def __get__(self, instance, cls):
 
 
 class View(object):
+    """Transform an :class:`object` into a dict
+
+    :param bool defaults: Include attributes of object
+    :param list include: A list of properties to include
+    :param list exclude: A list of attributes to exclude
+    :param bool ordered: Use an :class:`OrderedDict` instead
+    """
 
     def __init__(self, defaults=False, include=None, exclude=None,
                  ordered=False):
@@ -78,6 +85,7 @@ def getclassattr(instance, attr):
 
 @six.add_metaclass(ThingyMetaClass)
 class Thingy(object):
+    """Allows you to use object notation instead of dict notation"""
     _view_cls = View
     _silent = True