createdoc.py
author Sandro Knauß <knauss@netzguerilla.net>
Tue, 06 Dec 2011 19:46:00 +0100
changeset 72 e7b44716a564
child 73 f2f247a5b6c9
permissions -rwxr-xr-x
adding documentation
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
72
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     1
#!/usr/bin/env python2.7
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     2
# -*- coding: utf-8 -*- 
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     3
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     4
from genshi.template import TemplateLoader
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     5
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     6
loader = TemplateLoader('doc/tmpl', auto_reload=True)
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     7
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     8
import re
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     9
import inspect
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    10
from iro.user import User
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    11
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    12
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    13
user_methods = dict(inspect.getmembers(User(None,None)))
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    14
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    15
class Link():
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    16
    def __init__(self,name,title):
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    17
        self.name=name
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    18
        self.title=title
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    19
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    20
    def getLink(self):
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    21
        return self.name
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    22
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    23
    def __getitem__(self,name):
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    24
        if name == "link":
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    25
            return self.getLink()
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    26
        return AttributeError(name)
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    27
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    28
class Site(Link):
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    29
    pass
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    30
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    31
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    32
class Keyword():
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    33
    def __init__(self,name,typ,description):
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    34
        self.name=name
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    35
        self.typ=typ
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    36
        self.description=description
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    37
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    38
def section(text):
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    39
    ret={}
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    40
    li=[]
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    41
    kw=None
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    42
    for line in text.split("\n"):
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    43
        if re.match("^\s*$",line):
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    44
            continue
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    45
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    46
        if line[0] not in (" ","\t"):
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    47
            if kw:
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    48
                ret[kw.name]=kw
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    49
                li.append(kw)
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    50
            l=re.match(r"^(?P<name>[a-zA-Z0-9-_.]*)\[(?P<typ>[a-zA-Z0-9-_]*)\]:(?P<d>.*)$",line)
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    51
            kw=Keyword(name=l.group("name"),typ=l.group("typ"),description=l.group("d"))
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    52
        else:
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    53
            kw.description+="\n"+line.strip()
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    54
    if kw:
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    55
        ret[kw.name]=kw
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    56
        li.append(kw)
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    57
    return ret,li
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    58
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    59
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    60
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    61
def keywords(f):
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    62
    doc=f.__doc__
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    63
    kwds=re.search("Keywords:\n(?P<keywords>(?P<whitespace>\s*)(.+\n)*)\n",doc)
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    64
    k=kwds.group("keywords")
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    65
    #get rid of beginning whitespaces
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    66
    k=re.sub(re.compile(r"^"+kwds.group("whitespace"),re.M),"",k)
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    67
    return section(k)
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    68
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    69
def ret(f):
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    70
    doc=f.__doc__
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    71
    kwds=re.search("Return:\n(?P<ret>(?P<whitespace>\s*)(.+\n)*)\n",doc)
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    72
    k=kwds.group("ret")
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    73
    #get rid of beginning whitespaces
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    74
    k=re.sub(re.compile(r"^"+kwds.group("whitespace"),re.M),"",k)
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    75
    return section(k)
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    76
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    77
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    78
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    79
class Arg():
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    80
    def __init__(self,name,f):
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    81
        self.name=name
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    82
        k,_ = keywords(f)
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    83
        kwd=k[name]
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    84
        self.typ=kwd.typ
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    85
        self.description=kwd.description
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    86
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    87
        
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    88
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    89
class Method(Link):
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    90
    def __init__(self,name,title):
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    91
        Link.__init__(self,name,title)
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    92
        m=user_methods[name]
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    93
        self.description = m.__doc__.split("\n")[0]
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    94
        a=inspect.getargspec(m)
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    95
        self.args=[Arg(a,m) for a in a.args if a is not "self"]
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    96
        _, self.rets=ret(m)
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    97
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    98
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    99
def main():
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   100
    sites=[Site("index.html","Iro"),
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   101
           Site("current.html","API Documentation"),
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   102
           Site("new.html","geplante API Documentation"),
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   103
           Site("impressum.html","Impressum"),
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   104
           ]
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   105
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   106
    methods=[
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   107
            Method("startSMS","StartSMS"),
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   108
            Method("startFAX","StartFAX"),
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   109
            Method("startMail","StartMail"),
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   110
            
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   111
            Method("status","Status"),
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   112
            Method("stop","Stop"),
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   113
            
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   114
            Method("getProvider","GetProvider"),
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   115
            Method("getDefaultProvider","GetDefaultProvider"),
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   116
            ]
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   117
    for site in sites:
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   118
        print("generiere %s" % site.name)
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   119
        tmpl = loader.load(site.name)
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   120
        def a(s):
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   121
            if s == site:
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   122
                return {"class":"menu active"}
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   123
        stream = tmpl.generate(sites=sites,active=a,methods=methods)
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   124
        with open('doc/'+site.name, "w") as g:
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   125
            g.write(stream.render('html', doctype='html'))
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   126
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   127
if __name__ == '__main__':
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   128
    main()