Doc strings and text for web interface

This commit is contained in:
Florian Festi 2016-03-15 21:29:03 +01:00
parent 0a4c90e113
commit 5dabd9991d
7 changed files with 18 additions and 1 deletions

View File

@ -76,7 +76,15 @@ class BServer:
result = ["""<html> result = ["""<html>
<head><title>Boxes for Laser Cutters</title></head> <head><title>Boxes for Laser Cutters</title></head>
<body> <body>
Text <h1>boxes.py</h1>
<p>
A Python based generator for laser cut boxes and other things.
</p>
<p>It features both finished parametrized generators as well as a Python API
for writing your own scripts. It features finger and (flat) dovetail joints,
flex cuts, holes and slots for screws and more high level functions.
</p>
<p>These are the available generators:</p>
<ul> <ul>
""" ] """ ]
for name in sorted(self.boxes): for name in sorted(self.boxes):

View File

@ -17,6 +17,8 @@
from boxes import * from boxes import *
class Box(Boxes): class Box(Boxes):
"""Not yet parametrized box for drills from 1 to 12.5mm
in 0.5mm steps, 3 holes each size"""
def __init__(self): def __init__(self):
Boxes.__init__(self) Boxes.__init__(self)
self.x, self.y, self.h = 120, 240, 60 self.x, self.y, self.h = 120, 240, 60

View File

@ -18,6 +18,7 @@ from boxes import *
import math import math
class Folder(Boxes): class Folder(Boxes):
"""Book cover with flex for the spine"""
def __init__(self): def __init__(self):
Boxes.__init__(self) Boxes.__init__(self)

View File

@ -17,6 +17,7 @@
from boxes import * from boxes import *
class Box(Boxes): class Box(Boxes):
"""Open magazine file"""
def __init__(self): def __init__(self):
Boxes.__init__(self) Boxes.__init__(self)
self.buildArgParser("x", "y", "h", "hi") self.buildArgParser("x", "y", "h", "hi")

View File

@ -17,6 +17,9 @@
from boxes import Boxes from boxes import Boxes
class Silverware(Boxes): class Silverware(Boxes):
"""Not yet parametrized cuttlery stand with carrying grip
using flex for rounded corners"""
#################################################################### ####################################################################
### Parts ### Parts
#################################################################### ####################################################################

View File

@ -17,6 +17,7 @@
from boxes import * from boxes import *
class TrayInsert(Boxes): class TrayInsert(Boxes):
"""Tray insert without floor and outer walls - allows only continuous walls"""
def __init__(self): def __init__(self):
Boxes.__init__(self) Boxes.__init__(self)
self.buildArgParser("sx", "sy", "h") self.buildArgParser("sx", "sy", "h")

View File

@ -17,6 +17,7 @@
from boxes import * from boxes import *
class TypeTray(Boxes): class TypeTray(Boxes):
"""Type tray - allows only continuous walls"""
def __init__(self): def __init__(self):
Boxes.__init__(self) Boxes.__init__(self)
self.buildArgParser("sx", "sy", "h", "hi") self.buildArgParser("sx", "sy", "h", "hi")