Updated documentation

This commit is contained in:
jpk 2019-10-03 10:46:13 +02:00
parent 60a1dc7bf9
commit 6e0729e6f0
5 changed files with 23 additions and 10 deletions

View File

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

View File

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

View File

@ -1,15 +1,12 @@
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
"""SuperBeam Handlers """SuperBeam Handlers
SuperBeam Handlers define how to handle certain requests to the The handlers are automatically registered during the creation of the
`SuperBeamServer`. Each handler needs to be registered in ThumbHandler :class:`SuperBeamServer` instance.
`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.
Each class handler method needs to be a ``staticmethod``. The callee will call 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 import os

View File

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

View File

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