Updated documentation

source/conf.py

@@ -22,10 +22,10 @@ copyright = '2019, Julian Knauer'
 author = 'Julian Knauer'
 
 # The short X.Y version
-version = '0.3'
+version = '0.5'
 
 # The full version, including alpha/beta/rc tags
-release = '0.3'
+release = 'alpha'
 
 
 # -- General configuration ---------------------------------------------------

source/index.rst

@@ -6,11 +6,24 @@
 Welcome to SuperBeam documentation!
 ===================================
 
+
+Command line tool
+-----------------
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
    sbeam
+
+
+SuperBeam Development
+---------------------
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
    SuperBeam
    SuperBeam.RequestHandlers
 

src/SuperBeam/RequestHandlers.py

@@ -1,15 +1,12 @@
 # -*- coding: utf-8 -*-
 """SuperBeam Handlers
 
-SuperBeam Handlers define how to handle certain requests to the
-`SuperBeamServer`. Each handler needs to be registered in ThumbHandler
-`SuperBeamServer.do_GET()` function within the ``paths`` variable and imported
-in the top of the :mod:`SuperBeam` module.
-
-The handlers itself are defined in this module.
+The handlers are automatically registered during the creation of the
+:class:`SuperBeamServer` instance.
 
 Each class handler method needs to be a ``staticmethod``. The callee will call
-the `handle()` with the ``httpd`` instance of the :class:`SuperBeamServer`.
+the `handle()` with the ``httpd`` instance of the :class:`SuperBeamServer` as
+required argument.
 """
 
 import os

src/SuperBeam/__init__.py

@@ -20,6 +20,9 @@ class SuperBeamServer(BaseHTTPRequestHandler):
     Class is built on top of :mod:`http.server.BaseHTTPRequestHandler` as
     simple http server.
 
+    During initialization, the RequestHandlers are registered as routable
+    paths.
+
     Call :func:`serve_forever()` to start the HTTP server. The mainloop will
     serve a list of files given as argument to :func:`serve_forever()`.
 

src/sbeam.py

@@ -31,7 +31,7 @@ import requests
 import SuperBeam
 
 
-__VERSION__ = '0.4'
+__VERSION__ = '0.5'
 
 
 @click.group()