Docs tweak for first docs deployment

README.md

@@ -38,6 +38,16 @@ Install using `pip`...
 
 **TODO**
 
+# Development
+
+To build the docs.
+
+    ./mkdocs.py
+
+To run the tests.
+
+    ./djangorestframework/runtests/runtests.py
+
 # Changelog
 
 ## 2.0.0
@@ -71,7 +81,7 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 
 [twitter]: https://twitter.com/_tomchristie
-[docs]: https://github.com/tomchristie/django-rest-framework/blob/restframework2/docs/index.md
+[docs]: http://tomchristie.github.com/django-rest-framework/
 [urlobject]: https://github.com/zacharyvoase/urlobject
 [markdown]: http://pypi.python.org/pypi/Markdown/
 [pyyaml]: http://pypi.python.org/pypi/PyYAML

djangorestframework/runtests/runtests.py

@@ -1,8 +1,5 @@
-'''
-Created on Mar 10, 2011
+#!/usr/bin/env python
 
-@author: tomchristie
-'''
 # http://ericholscher.com/blog/2009/jun/29/enable-setuppy-test-your-django-apps/
 # http://www.travisswicegood.com/2010/01/17/django-virtualenv-pip-and-fabric/
 # http://code.djangoproject.com/svn/django/trunk/tests/runtests.py
@@ -13,6 +10,7 @@ os.environ['DJANGO_SETTINGS_MODULE'] = 'djangorestframework.runtests.settings'
 from django.conf import settings
 from django.test.utils import get_runner
 
+
 def usage():
     return """
     Usage: python runtests.py [UnitTestClass].[method]
@@ -22,6 +20,7 @@ def usage():
     Append a method name if you only want to test a specific method of that class.
     """
 
+
 def main():
     TestRunner = get_runner(settings)
 

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

docs/template.html

@@ -102,6 +102,7 @@ margin-top: 5px;
                 <ul class="dropdown-menu">
                   <li><a href="{{ base_url }}/topics/csrf{{ suffix }}">Working with AJAX and CSRF</a></li>
                   <li><a href="{{ base_url }}/topics/formoverloading{{ suffix }}">Browser based PUT, PATCH and DELETE</a></li>
+                  <li><a href="{{ base_url }}/topics/credits{{ suffix }}">Credits</a></li>
                 </ul>
               </li>
             </ul>