Metadata-Version: 2.0
Name: wagtail-utphy-richdocument
Version: 0.5
Summary: A Wagtail richdocument content type built with wagtail straemfield.
Home-page: https://github.com/jcuotpc/wagtail-utphy-richdocument
Author: Julian Comanean
Author-email: icom@physics.utoronto.ca
License: BSD License
Keywords: wagtail,richdocument
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content

utphy richdocument
==================

This is a wagtail app to be applied on wagtail generic docs.
It adds the following streamfield blocks:

- doc_byline
- body_text
- quote
- bustout
- code_chunk
- math_formula
- table
- media_embed

Dependencies
------------

- wagtail_

.. _wagtail: https://wagtail.io

Quick Start
-----------
1. install with::

    pip install wagtail-utphy-richdocument

2. add "utphy_richdocument" to your INSTALLED_APPS setting::

    INSTALLED_APPS = [
        ...
        'utphy_richdocument',
    ]

3. In your own app create a new model which subclasses the StreamFieldDoc model::

    from utphy_richdocument.models import StreamFieldDoc

    class YourModel(StreamFieldDoc):
        template = 'path_to_your_template.html'

4. Run `python manage.py collectstatic` to collect the static files from the app into your own static section.

5. Run `python manage.py migrate` to update the tables in your app.


