From b9177f740bf91e6e39abd0991f030d592b7ca6e5 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Sat, 1 Sep 2012 21:35:30 +0100 Subject: Docs tweak for first docs deployment --- docs/index.md | 14 ++++++++++++-- docs/template.html | 1 + 2 files changed, 13 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/index.md b/docs/index.md index 340c6734..31bb9deb 100644 --- a/docs/index.md +++ b/docs/index.md @@ -21,8 +21,6 @@ The following packages are optional: * [Markdown][markdown] (2.1.0+) - Markdown support for the self describing API. * [PyYAML][yaml] (3.10+) - YAML content type support. -If you're installing using `pip`, all requirements and optional packages will be installed by default. - ## Installation **WARNING: These instructions will only become valid once this becomes the master version** @@ -89,6 +87,18 @@ General guides to using REST framework. * [Form overloading][formoverloading] * [Credits][credits] +## Development + +If you want to work on REST framework itself, clone the repository, then... + +Build the docs: + + ./mkdocs.py + +Run the tests: + + ./djangorestframework/runtests/runtests.py + ## License Copyright (c) 2011-2012, Tom Christie diff --git a/docs/template.html b/docs/template.html index a8a0d741..e452ead7 100644 --- a/docs/template.html +++ b/docs/template.html @@ -102,6 +102,7 @@ margin-top: 5px; -- cgit v1.2.3