2015-03-28 16:33:29 +00:00
|
|
|
.. include:: ../README.rst
|
|
|
|
|
|
2015-03-28 17:04:21 +00:00
|
|
|
API Documentation
|
|
|
|
|
-----------------
|
|
|
|
|
|
|
|
|
|
correlation.HandlerMixin
|
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
|
.. autoclass:: sprockets.mixins.correlation.HandlerMixin
|
|
|
|
|
:members:
|
|
|
|
|
|
2015-03-28 16:33:29 +00:00
|
|
|
Contributing to this Library
|
|
|
|
|
----------------------------
|
|
|
|
|
|
|
|
|
|
The easiest way to start working with this code is to set up a virtual
|
|
|
|
|
environment and run ``env/bin/pip -r dev-requirements.txt``. That will
|
|
|
|
|
install the necessary testing tools. Then you can run everything else
|
|
|
|
|
using ``env/bin/python setup.py``:
|
|
|
|
|
|
|
|
|
|
- *setup.py nosetests* will run the tests using nose to test against the
|
|
|
|
|
and generate a coverage report to stdout.
|
|
|
|
|
|
|
|
|
|
- *setup.py build_sphinx* will generate HTML documentation into
|
|
|
|
|
*build/doc/html*. This is the doc set that is uploaded to Read The Docs.
|
|
|
|
|
|
|
|
|
|
- *setup.py flake8* will run the ``flake8`` utility and report on any
|
|
|
|
|
static code analysis failures.
|
|
|
|
|
|
|
|
|
|
This library follows the standard fork, modify, and pull request flow
|
|
|
|
|
for contributing.
|
|
|
|
|
|
|
|
|
|
.. include:: ../HISTORY.rst
|
