Stefan Scherfke avatar Stefan Scherfke committed d549f91

Doc updates.

Comments (0)

Files changed (2)

 Requirements
 ------------
 
-This app is tested with Django 1.1 and 1.2. You also need `Sphinx
+This app is tested with Django >= 1.1. You also need `Sphinx
 <http://sphinx.pocoo.org/>`_ >= 1.0 and `Haystack
 <http://haystacksearch.org/>`_.
 
 Installation
 ------------
 
-You can either install this app with `PIP <http://pypi.python.org/pypi/pip>`_ 
-(or ``easy_install``)::
+You can either install this app with `PIP <http://pypi.python.org/pypi/pip>`_::
 
     $ pip install django-sphinxdoc
-    $ # or:
-    $ easy_install django-sphinxdoc
 
 or download and install it manually::
 
     $ cd where/you/put/django-sphinxdoc/
     $ python setup.py install
-    
-Use `this URL <http://bitbucket.org/scherfke/django-sphinxdoc/>`_ for cloning if
-you want to install this app in development mode.
-    
+
+Use `this URL <http://bitbucket.org/scherfke/django-sphinxdoc/>`_ for cloning
+if you want to install this app in development mode.
+
 
 Usage
 -----

sphinxdoc/views.py

 
     def extra_context(self):
         """
-        Adds the project, the contents of ``globalcontext.json`` and the
-        update date as extra context.
+        Adds the *project*, the contents of ``globalcontext.json`` (*env*) and
+        the *update_date* as extra context.
 
         """
         project = Project.objects.get(slug=self.slug)
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.