From 2ab94a002218550c918d8eb7ec5af7d18a7b7bc8 Mon Sep 17 00:00:00 2001 From: Dave Cranwell Date: Thu, 14 May 2015 14:21:36 +0100 Subject: [PATCH] made difference clearer between coding style and styleguide --- docs/contributing/developing.rst | 25 +++++++++++++++++-------- docs/contributing/styleguide.rst | 4 ++-- 2 files changed, 19 insertions(+), 10 deletions(-) diff --git a/docs/contributing/developing.rst b/docs/contributing/developing.rst index fdef61cf7..290ae4731 100644 --- a/docs/contributing/developing.rst +++ b/docs/contributing/developing.rst @@ -1,5 +1,5 @@ -Development process -------------------- +Development +----------- Using the demo site & Vagrant ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -28,12 +28,22 @@ Uncomment the lines from ``import sys`` onward, and edit the rest of ``local.py` If your VM is currently running, you'll then need to run ``vagrant halt`` followed by ``vagrant up`` for the changes to take effect. -Unit tests -~~~~~~~~~~ +Development dependencies +~~~~~~~~~~~~~~~~~~~~~~~~ -Wagtail has extensive tests which should be run before submitting pull requests. To run Wagtail's test suite you will need to install some dependencies. We recommend installing these into a virtual environment. +Developing Wagtail requires additional Python modules for testing and documentation. -**Setting up the virtual environment** +The list of dependencies is in the Wagtail root directory in ``requirements-dev.txt`` and if you've used the Vagrant environment above, can be installed thus, from the Wagtail codebase root directory:: + + pip install -r requirements-dev.txt + + +Testing +~~~~~~~ + +Wagtail has unit tests which should be run before submitting pull requests. + +**Testing virtual environment** (skip this if working in Vagrant box) If you are using Python 3.3 or above, run the following commands in your shell at the root of the Wagtail repo:: @@ -50,8 +60,7 @@ the first line above with: **Running the tests** -With your virtual environment active, run the following command to run all the -tests:: +From the root of the Wagtail codebase, run the following command to run all the tests:: python runtests.py diff --git a/docs/contributing/styleguide.rst b/docs/contributing/styleguide.rst index fd5231fdc..a2357e5fc 100644 --- a/docs/contributing/styleguide.rst +++ b/docs/contributing/styleguide.rst @@ -1,5 +1,5 @@ -Styleguide -========== +UI Styleguide +============= Developers working on the Wagtail UI or creating new UI components may wish to test their work against our Styleguide, which is provided as the contrib module "wagtailstyleguide".