Update formatting in documents

docs/source/api.rst

@@ -1,6 +1,6 @@
-django-helpdesk Ticket API
-==========================
+Ticket API
+==========
 
 django-helpdesk includes an API accessible via HTTP POST requests, allowing you to create and alter tickets from 3rd party software and systems.
 
-For usage instructions and command syntax, see the file templates/helpdesk/api_help.html, or visit http://helpdesk/api/help/.
+For usage instructions and command syntax, see the file ``templates/helpdesk/api_help.html``, or visit http://helpdesk/api/help/.

docs/source/configuration.rst

@@ -1,5 +1,5 @@
-django-helpdesk Configuration
-=============================
+Configuration
+=============
 
 Before django-helpdesk will be much use, you need to do some basic configuration. Most of this is done via the Django admin screens.
 

docs/source/custom_fields.rst

@@ -1,5 +1,5 @@
-django-helpdesk custom fields
-=============================
+Custom Fields
+=============
 
 As of February 2011, django-helpdesk supports custom fields on the ``Ticket`` model. These fields are created by using the Django administration tool, and are shown on both the public and staff submission forms. 
 

docs/source/install.rst

@@ -15,7 +15,7 @@ Try using ``pip install django-helpdesk``. Go and have a beer to celebrate Pytho
 GIT Checkout (Cutting Edge)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-``git clone git://github.com/rossp/django-helpdesk.git``
+If you're planning on editing the code or just want to get whatever is the latest and greatest, you can clone the official Git repository with ``git clone git://github.com/rossp/django-helpdesk.git``
 
 Copy the ``helpdesk`` folder into your ``PYTHONPATH``.
 
@@ -49,30 +49,30 @@ Adding To Your Django Project
 
    ./manage.py syncdb
 
-4. Inside your ``MEDIA_ROOT`` folder, create a new folder called ``helpdesk`` and copy the contents of ``helpdesk/htdocs`` into it. Alternatively, create a symlink:
+4. Inside your ``MEDIA_ROOT`` folder, create a new folder called ``helpdesk`` and copy the contents of ``helpdesk/htdocs`` into it. Alternatively, create a symlink::
 
-   ``ln -s /path/to/helpdesk/htdocs /path/to/media/helpdesk``
+      ln -s /path/to/helpdesk/htdocs /path/to/media/helpdesk
 
 5. Inside your ``MEDIA_ROOT`` folder, inside the ``helpdesk`` folder, is a folder called ``attachments``. Ensure your web server software can write to this folder - something like this should do the trick::
 
-        chown www-data:www-data attachments/
-        chmod 700 attachments
+      chown www-data:www-data attachments/
+      chmod 700 attachments
 
-    (substitute www-data for the user / group that your web server runs as, eg 'apache' or 'httpd')
+   (substitute www-data for the user / group that your web server runs as, eg 'apache' or 'httpd')
 
-    If all else fails ensure all users can write to it:
+   If all else fails ensure all users can write to it::
 
-    ``chmod 777 attachments/``
+      chmod 777 attachments/
 
-    This is NOT recommended, especially if you're on a shared server.
+   This is NOT recommended, especially if you're on a shared server.
 
 6. Ensure that your ``attachments`` folder has directory listings turned off, to ensure users don't download files that they are not specifically linked to from their tickets.
 
-   If you are using Apache, put a ``.htaccess`` file in the ``attachments`` folder with the following content:
+   If you are using Apache, put a ``.htaccess`` file in the ``attachments`` folder with the following content::
 
-   ``Options -Indexes``
+      Options -Indexes
 
-   You will also have to make sure that ``.htaccess`` files aren't being ignored.
+You will also have to make sure that ``.htaccess`` files aren't being ignored.
 
-   Ideally, accessing http://MEDIA_URL/helpdesk/attachments/ will give you a 403 access denied error.
+Ideally, accessing http://MEDIA_URL/helpdesk/attachments/ will give you a 403 access denied error.
 

docs/source/settings.rst

@@ -1,5 +1,5 @@
-django-helpdesk settings
-========================
+Settings
+========
 
 The following settings can be changed in your ``settings.py`` file to help change the way django-helpdesk operates.
 

docs/source/spam.rst

@@ -1,9 +1,9 @@
-django-helpdesk spam filtering
-==============================
+Spam Filtering
+==============
 
-django-helpdesk includes a copy of ``akismet.py`` by Michael Foord, which lets incoming ticket submissions be automatically checked against either the Akismet or TypePad Anti-Spam services.
+django-helpdesk includes a copy of ``akismet.py`` by `Michael Foord <http://www.voidspace.org.uk/>`, which lets incoming ticket submissions be automatically checked against either the `Akismet <http://akismet.com/>` or `TypePad Anti-Spam <http://antispam.typepad.com/>` services.
 
-To enable this functionality, sign up for an API key with one of the following services:
+To enable this functionality, sign up for an API key with one of these two services.
 
 Akismet
 ~~~~~~~
@@ -26,6 +26,7 @@ If you have either of these settings enabled, the spam filtering will be done au
 Example
 ~~~~~~~
 
-A sample configuration in ``settings.py`` may be:
+A sample configuration in ``settings.py`` may be::
+
+   TYPEPAD_ANTISPAM_API_KEY = 'abc123'
 
-TYPEPAD_ANTISPAM_API_KEY = 'abc123'