Merge pull request #7 from JamoBox/sphinx-docs

Added Sphinx docs

docs/.gitignore

@@ -0,0 +1 @@
+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    = django-notify
+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/requirements.txt

@@ -0,0 +1,2 @@
+Sphinx
+sphinx_rtd_theme

docs/source/conf.py

@@ -0,0 +1,163 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# django-notify documentation build configuration file, created by
+# sphinx-quickstart on Thu Feb 16 20:57:01 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('.'))
+import sphinx_rtd_theme
+
+
+# -- 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.doctest',
+              'sphinx.ext.todo',
+              'sphinx.ext.viewcode',
+              'sphinx.ext.githubpages']
+
+# 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'
+
+# General information about the project.
+project = 'django-notify'
+copyright = '2017, Pete Wicken'
+author = 'Pete Wicken'
+
+# 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.1.0'
+# The full version, including alpha/beta/rc tags.
+release = '0.1.0'
+
+# 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 = []
+
+# 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 = 'sphinx_rtd_theme'
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+
+# 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']
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'django-notifydoc'
+
+
+# -- 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, 'django-notify.tex', 'django-notify Documentation',
+     'Pete Wicken', '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, 'django-notify', 'django-notify 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, 'django-notify', 'django-notify Documentation',
+     author, 'django-notify', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+

docs/source/content/concepts.rst

@@ -0,0 +1,46 @@
+Concepts
+========
+
+Custom defined dynamic routing keys
+-----------------------------------
+
+In order to get around redefining routing keys for each model everytime you call ``@notify``, or having one static global one used for evrything, we have settings options to allow you to dynamically set them using basic string formatting.
+
+For example; you can set this as your routing key format definition:
+
+.. code-block:: python
+
+    DJANGO_NOTIFY_ROUTING_KEY = 'model.{}.{}.{}'``
+
+Which is saying, always start the routing key with the string literal ``model`` and then delimit three additional bits of data with ``.``.
+
+To define the 'extra bits of data', you use This is where you define the structure of your routing key. This string gets interpolated with the contents of the tuple in the following variable:
+
+.. code-block:: python
+
+    DJANGO_NOTIFY_ROUTING_KEY_ARGS = ('name', 'author', 'pk')
+
+The strings defined in here are class attributes of the class - So in Django that means model fields. Here is an example of what this would generate:
+
+``model.my_book_name.joe_bloggs.123``
+
+This is easy, but most people will want a little more structure and context for their routing keys. Enter stage left, routing key formatters!
+Out of the box, django-notify provides you with some pretty simple but useful formatters. Here is an example of using one:
+
+.. code-block:: python
+
+    from django_notify import formatters
+
+    DJANGO_NOTIFY_ROUTING_KEY_ARGS = (formatters.EventType, 'name', 'pk')
+
+This will format into your routing key a contextual model event type:
+
+``model.create.my_book_name.123``
+
+Cool, but we can do better. As the strings we pass into our routing key arguments are just class attributes, we can sneak in some arguments that access more fundamental object fields. For example, let's say I want the actual model class name in the routing key? Simple python always wins.
+
+.. code-block:: python
+
+     DJANGO_NOTIFY_ROUTING_KEY_ARGS = (formatters.EventType, '__class__.__name__', 'pk')
+
+``model.create.MyModel.123``

docs/source/content/ideas.rst

@@ -0,0 +1,4 @@
+Ideas
+=====
+
+A place for future project ideas.

docs/source/index.rst

@@ -0,0 +1,46 @@
+Welcome to django-notify's documentation!
+=========================================
+
+django-notify is a Django plug-in for automatically publishing AMQP events when models are modified.
+
+Adding a notification event is as simple as adding an ``@notify`` decorator to your model class. By default, the decorator will publish an event for any ``create``, ``read``, ``update`` and ``delete`` (CRUD) action on your model.
+
+.. code-block:: python
+
+    @notify
+    class MyModel(models.Model):
+        pass
+
+This behaviour can be modified to selectively act upon any combination of CRUD events:
+
+.. code-block:: python
+
+    @notify(when='CD')
+    class MyModel(models.Model):
+        pass
+
+To specify which fields should be included in the AMQP body; add it to fields:
+
+.. code-block:: python
+
+    @notify(when='CRUD', fields=('pk', 'name'))
+    class MyModel(models.Model):
+        name = models.CharField()
+
+That's it! For further configuration options such as generating custom routing keys for your events, see the :doc: `concepts` page.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   content/ideas
+   content/concepts
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`