Add documentation.

This commit is contained in:
Dave Shawley 2015-03-28 13:04:21 -04:00
parent 208e5c7884
commit 9e59113a15
2 changed files with 10 additions and 0 deletions

View file

@ -21,4 +21,6 @@ html_theme = 'sphinx_rtd_theme'
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
intersphinx_mapping = {
'python': ('https://docs.python.org/', None),
'sprockets': ('https://sprockets.readthedocs.org/en/latest/', None),
'tornado': ('http://www.tornadoweb.org/en/latest/', None),
}

View file

@ -1,5 +1,13 @@
.. include:: ../README.rst
API Documentation
-----------------
correlation.HandlerMixin
~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: sprockets.mixins.correlation.HandlerMixin
:members:
Contributing to this Library
----------------------------