From cd194ab133caed7bb0407c06b58d33ec6bcfaf8e Mon Sep 17 00:00:00 2001 From: Christopher Neugebauer Date: Tue, 26 Apr 2016 13:54:28 +1000 Subject: [PATCH] Fixes the documentation for installation. --- docs/integration.rst | 17 +++++++++++++++-- docs/views.rst | 2 +- 2 files changed, 16 insertions(+), 3 deletions(-) diff --git a/docs/integration.rst b/docs/integration.rst index 36d33795..827d99a7 100644 --- a/docs/integration.rst +++ b/docs/integration.rst @@ -1,5 +1,5 @@ -Integrating Registrasion -======================== +Installing and integrating Registrasion +======================================= Registrasion is a Django app. It does not provide any templates -- you'll need to develop these yourself. You can use the `registrasion-demo `_ project as a starting point. @@ -8,6 +8,19 @@ To use Registrasion for your own conference, you'll need to do a small amount of The configuration that you'll need to do is minimal. The first piece of development work is to define a model and form for your attendee profile, and the second is to implement a payment app. +Installing Registrasion +----------------------- + +Registrasion depends on an in-development version of Symposion. You'll need to add the following two lines to your ``requirements.txt`` files:: + + git+https://github.com/pinax/symposion.git@ad81810 + git+https://github.com/chrisjrn/registrasion.git@releases/0.1 + +Symposion currently specifies Django version 1.9.2. + +Running ``pip install -r requirements.txt`` will pull down the git version of Symposion as well as the current 0.1 release of Registrasion. + + Configuring your Django App --------------------------- diff --git a/docs/views.rst b/docs/views.rst index 96429a7d..313337ec 100644 --- a/docs/views.rst +++ b/docs/views.rst @@ -38,4 +38,4 @@ You'll need to render the following Django models in order to view invoices. .. autoclass:: LineItem -.. autoclass:: PaymentBase +See also: :class:`PaymentBase`