update the docs, creating a simple structure for user orientated documentation

docs/source/conf.py

@@ -12,6 +12,7 @@
 # serve to show the default value.
 
 import sys, os
+import deluge.common
 
 # If your extensions are in another directory, add it here. If the directory
 # is relative to the documentation root, use os.path.abspath to make it
@@ -42,9 +43,9 @@ copyright = '2008, Andrew Resch'
 # other places throughout the built documents.
 #
 # The short X.Y version.
-version = '1.1.0'
+version = deluge.common.get_version()
 # The full version, including alpha/beta/rc tags.
-release = '1.1.0'
+release = deluge.common.get_version()
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:

docs/source/core/index.rst

@@ -0,0 +1,2 @@
+The Deluge Core
+===============

docs/source/index.rst

@@ -2,13 +2,16 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to deluge's documentation!
+Welcome to Deluge's documentation!
 ==================================
 
 Contents:
 
 .. toctree::
    :maxdepth: 2
+   
+   Core <core/index.rst>
+   Interfaces <interfaces/index.rst>
 
 Indices and tables
 ==================

docs/source/interfaces/console.rst

@@ -0,0 +1,2 @@
+Deluge Console UI
+=================

docs/source/interfaces/gtk.rst

@@ -0,0 +1,2 @@
+Deluge GTK UI
+=============

docs/source/interfaces/index.rst

@@ -0,0 +1,10 @@
+Deluge's Interfaces
+===================
+
+Interfaces.
+
+.. toctree::
+
+    Gtk Interface <gtk>
+    Web Interface <web>
+    Console Interface <console>

docs/source/interfaces/web.rst

@@ -0,0 +1,19 @@
+Deluge Web UI
+=============
+
+The Deluge web interface is intended to be a full featured interface built using
+the ExtJS framework, running on top of a Twisted webserver.
+
+
+=================
+SSL Configuration
+=================
+By default the web interface will use the same private key and certificate as
+the Deluge daemon. If you wish to use a different certificate/key (see 
+`How to Create a SSL Certificate <http://www.yatblog.com/2007/02/27/how-to-create-a-ssl-certificate/>`_
+for information on creating one) you are able to specify which you want to use.
+
+There are 2 ways to enable SSL encryption in the webserver, 1 is to specify it
+in your configuration (accessible via the Preferences window). The other is to
+add '--ssl' when running the webserver, which will override the configuration
+value and enable SSL.