Initial documentation complete.

Author: Perlkonig

README.rst

@@ -23,8 +23,8 @@ For now, download and install manually::
 Contribute
 ----------
 
-- Issue Tracker: <github.com/Perlkonig/sqrlserver-python/issues>
-- Source Code: <github.com/Perlkonig/sqrlserver-python>
+- Issue Tracker: <https://github.com/Perlkonig/sqrlserver-python/issues>
+- Source Code: <https://github.com/Perlkonig/sqrlserver-python>
 
 License
 -------

docs/conf.py

@@ -121,7 +121,7 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'alabaster'
+html_theme = 'sphinx_rtd_theme'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

docs/divergences.rst

@@ -0,0 +1,8 @@
+Divergences
+===========
+
+The spec is still in flux. These are the known divergences/caveats related to how this library represents the spec.
+
+- Status code 0x100 is not currently used. If IDs ever get rolled into the nut, then this could change.
+
+- The spec is unclear about how to handle unsupported options. For now, the library leaves it up to the server to decide whether to hard or soft fail an option request. Hard fail will result in setting TIF codes 0x10 and 0x80 and aborting any requested actions. A soft fail will result in the command being successfully concluded without any notice to the user, unless the server chooses to use the ASK feature.

docs/index.rst

@@ -3,25 +3,56 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to SQRL Server's documentation!
-================================================
-
-Contents:
+#######################################
+SQRL Server
+#######################################
 
 .. toctree::
    :maxdepth: 2
+   :hidden:
+
+   usage
+   divergences
+   API <modules>
+
+This module supports Python-based web servers in processing `SQRL <https://www.grc.com/sqrl/sqrl.htm>`_ requests. It only does the core protocol work. It leaves data representation, storage, and other platform-specific actions to the server.
+
+The following terms are used throughout the documentation:
+
+user
+    The human actor interacting with the system
+
+client
+    The client software the user is using to interact
+
+server
+    The web service that is wanting to support SQRL interaction
+
+library
+    This code that supports the server in understanding SQRL interactions
+
+Installation
+============
+
+Eventually it will be available via PyPi::
+
+    pip install sqrlserver
+
+For now, download and install manually::
 
-   modules
+    python setup.py test
+    python setup.py install
 
-Usage
------
+Contribute
+==========
 
-Divergences
------------
+- Issue Tracker: <https://github.com/Perlkonig/sqrlserver-python/issues>
+- Source Code: <https://github.com/Perlkonig/sqrlserver-python>
 
-- Status code 0x100 is not currently used. If IDs ever get rolled into the nut, then this could change.
+Licence
+=======
 
-- The spec is unclear about how to handle unsupported options. For now, the library leaves it up to the server to decide whether to hard or soft fail an option request. Hard fail will result in setting TIF codes 0x10 and 0x80 and aborting any requested actions. A soft fail will result in the command being successfully concluded without any notice to the user, unless the server chooses to use the ASK feature.
+The project is licensed under the MIT licence.
 
 
 Indices and tables

docs/sqrlserver.rst

@@ -9,6 +9,7 @@ Submodules
    sqrlserver.nut
    sqrlserver.request
    sqrlserver.response
+   sqrlserver.url
    sqrlserver.utils
 
 Module contents

docs/sqrlserver.url.rst

@@ -0,0 +1,7 @@
+sqrlserver.url module
+=====================
+
+.. automodule:: sqrlserver.url
+    :members:
+    :undoc-members:
+    :show-inheritance: