| author | Sandro Knauß <knauss@netzguerilla.net> |
| Wed, 25 Apr 2012 00:05:53 +0200 | |
| branch | devel |
| changeset 275 | 88d45c846f2b |
| parent 271 | b218238e76b9 |
| child 277 | f65edc0382cc |
| permissions | -rwxr-xr-x |
| 72 | 1 |
#!/usr/bin/env python2.7 |
2 |
# -*- coding: utf-8 -*- |
|
3 |
||
4 |
from genshi.template import TemplateLoader |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
5 |
from genshi import Markup |
| 72 | 6 |
loader = TemplateLoader('doc/tmpl', auto_reload=True) |
7 |
||
8 |
import inspect |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
9 |
from docutils.core import publish_doctree |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
10 |
import docutils |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
11 |
|
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
12 |
#-- |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
13 |
from docutils import core |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
14 |
from docutils.writers.html4css1 import Writer,HTMLTranslator |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
15 |
|
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
16 |
class NoHeaderHTMLTranslator(HTMLTranslator): |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
17 |
def __init__(self, document): |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
18 |
HTMLTranslator.__init__(self,document) |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
19 |
self.body_prefix = [] |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
20 |
self.body_suffix = [] |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
21 |
|
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
22 |
_w = Writer() |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
23 |
_w.translator_class = NoHeaderHTMLTranslator |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
24 |
_w.visitor_attributes = ("html_body",) |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
25 |
|
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
26 |
def d(): |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
27 |
subs = _w.interpolation_dict() |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
28 |
return "%(html_body)s"%subs |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
29 |
|
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
30 |
_w.apply_template = d |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
31 |
|
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
32 |
def reSTify(s): |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
33 |
d =docutils.utils.new_document("") |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
34 |
if s.tagname == "paragraph": |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
35 |
d.append(s[0]) |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
36 |
else: |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
37 |
d.append(s) |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
38 |
|
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
39 |
return core.publish_from_doctree(d, writer=_w) |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
40 |
|
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
41 |
from iro.view.xmlrpc import TwistedInterface as Current |
| 72 | 42 |
|
|
251
3caa803a2dec
getting corresbonding table classes out of schema
Sandro Knauß <knauss@netzguerilla.net>
parents:
250
diff
changeset
|
43 |
from createerm import createSchemaPlot, tables, tables_cls |
|
76
9f7da8dc8df8
using decode('utf8') to get docstrings.
Sandro Knauß <knauss@netzguerilla.net>
parents:
74
diff
changeset
|
44 |
|
| 72 | 45 |
class Link(): |
46 |
def __init__(self,name,title): |
|
47 |
self.name=name |
|
48 |
self.title=title |
|
49 |
||
50 |
def getLink(self): |
|
51 |
return self.name |
|
52 |
||
53 |
def __getitem__(self,name): |
|
54 |
if name == "link": |
|
55 |
return self.getLink() |
|
56 |
return AttributeError(name) |
|
57 |
||
58 |
class Site(Link): |
|
59 |
pass |
|
60 |
||
61 |
class Keyword(): |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
62 |
def __init__(self, name=None, typ=None, description=None): |
| 72 | 63 |
self.name=name |
64 |
self.typ=typ |
|
65 |
self.description=description |
|
66 |
||
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
67 |
def __repr__(self): |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
68 |
return '<Keyword("%s", "%s", "%s")>'%(self.name, self.typ, self.description) |
| 72 | 69 |
|
70 |
def keywords(f): |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
71 |
NORMAL = 0 |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
72 |
TYPE = 1 |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
73 |
pd = publish_doctree(f.__doc__.decode('utf8')) |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
74 |
|
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
75 |
kws={} |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
76 |
for child in pd[1][0]: |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
77 |
kw = Keyword() |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
78 |
ftyp = NORMAL |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
79 |
for sc in child: |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
80 |
if sc.tagname == "field_name": |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
81 |
p = sc.astext().split() |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
82 |
if p[0] in ["param",]: |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
83 |
if len(p) == 3: #param typ name |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
84 |
kw.name = p[2] |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
85 |
kw.typ = p[1] |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
86 |
if len(p) == 2: |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
87 |
kw.name = p[1] |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
88 |
elif p[0] == "type": |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
89 |
kw = kws[p[1]] |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
90 |
ftyp=TYPE |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
91 |
elif p[0] in ["return","rtyp"]: |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
92 |
break |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
93 |
else: |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
94 |
raise Exception("Unknown field_name: %s"%(p[0])) |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
95 |
if sc.tagname == "field_body": |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
96 |
if ftyp == NORMAL: |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
97 |
kw.description = Markup(reSTify(sc[0])) |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
98 |
if ftyp == TYPE: |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
99 |
kw.typ = sc[0][0] |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
100 |
else: |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
101 |
kws[kw.name] = kw |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
102 |
return kws |
| 72 | 103 |
|
104 |
def ret(f): |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
105 |
NORMAL = 0 |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
106 |
TYPE = 1 |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
107 |
|
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
108 |
pd = publish_doctree(f.__doc__.decode('utf8')) |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
109 |
for child in pd[1][0]: |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
110 |
kw = Keyword(name="return") |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
111 |
ftyp = NORMAL |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
112 |
for sc in child: |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
113 |
if sc.tagname == "field_name": |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
114 |
p = sc.astext().split() |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
115 |
if p[0] == "return": |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
116 |
if len(p) == 2: |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
117 |
kw.typ = p[1] |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
118 |
elif p[0] == "rtype": |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
119 |
ftyp=TYPE |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
120 |
elif p[0] in ["param","type"]: |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
121 |
break |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
122 |
else: |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
123 |
raise Exception("Unknown field_name: %s"%(p[0])) |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
124 |
if sc.tagname == "field_body": |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
125 |
if ftyp == NORMAL: |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
126 |
kw.description = Markup(reSTify(sc[0])) |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
127 |
if ftyp == TYPE: |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
128 |
kw.typ = sc[0][0] |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
129 |
else: |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
130 |
return kw |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
131 |
|
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
132 |
raise Exception("no return description") |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
133 |
|
| 72 | 134 |
class Arg(): |
135 |
def __init__(self,name,f): |
|
136 |
self.name=name |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
137 |
k = keywords(f) |
| 72 | 138 |
kwd=k[name] |
139 |
self.typ=kwd.typ |
|
140 |
self.description=kwd.description |
|
141 |
||
142 |
class Method(Link): |
|
| 73 | 143 |
def __init__(self,name,methods): |
144 |
title=name[0].upper()+name[1:] |
|
| 72 | 145 |
Link.__init__(self,name,title) |
| 73 | 146 |
m=methods[name] |
|
74
c471fed3cab8
update document creation:
Sandro Knauß <knauss@netzguerilla.net>
parents:
73
diff
changeset
|
147 |
(args, varargs, keywords, defaults)=inspect.getargspec(m) |
|
250
91890ea7ed81
update docstrings in iro.controller.viewinterface for createdoc
Sandro Knauß <knauss@netzguerilla.net>
parents:
92
diff
changeset
|
148 |
a=[] |
|
91890ea7ed81
update docstrings in iro.controller.viewinterface for createdoc
Sandro Knauß <knauss@netzguerilla.net>
parents:
92
diff
changeset
|
149 |
for b in args: |
|
91890ea7ed81
update docstrings in iro.controller.viewinterface for createdoc
Sandro Knauß <knauss@netzguerilla.net>
parents:
92
diff
changeset
|
150 |
if b in ("self","session"): |
|
91890ea7ed81
update docstrings in iro.controller.viewinterface for createdoc
Sandro Knauß <knauss@netzguerilla.net>
parents:
92
diff
changeset
|
151 |
continue |
|
91890ea7ed81
update docstrings in iro.controller.viewinterface for createdoc
Sandro Knauß <knauss@netzguerilla.net>
parents:
92
diff
changeset
|
152 |
else: |
|
91890ea7ed81
update docstrings in iro.controller.viewinterface for createdoc
Sandro Knauß <knauss@netzguerilla.net>
parents:
92
diff
changeset
|
153 |
a.append(b) |
|
91890ea7ed81
update docstrings in iro.controller.viewinterface for createdoc
Sandro Knauß <knauss@netzguerilla.net>
parents:
92
diff
changeset
|
154 |
|
|
91890ea7ed81
update docstrings in iro.controller.viewinterface for createdoc
Sandro Knauß <knauss@netzguerilla.net>
parents:
92
diff
changeset
|
155 |
args = a |
|
74
c471fed3cab8
update document creation:
Sandro Knauß <knauss@netzguerilla.net>
parents:
73
diff
changeset
|
156 |
self.func_line=inspect.formatargspec(args, varargs, keywords, defaults) |
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
157 |
pd = publish_doctree(m.__doc__) |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
158 |
if pd[0].tagname == "paragraph": |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
159 |
self.description = pd[0].astext() |
|
74
c471fed3cab8
update document creation:
Sandro Knauß <knauss@netzguerilla.net>
parents:
73
diff
changeset
|
160 |
self.args=[Arg(a,m) for a in args] |
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
161 |
self.rets=[ret(m)] |
| 72 | 162 |
|
|
77
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
76
diff
changeset
|
163 |
class Table(Link): |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
76
diff
changeset
|
164 |
def __init__(self,cls): |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
76
diff
changeset
|
165 |
name=cls.__name__ |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
76
diff
changeset
|
166 |
self.tablename=cls.__tablename__ |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
76
diff
changeset
|
167 |
title=self.tablename[0].upper()+self.tablename[1:] |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
76
diff
changeset
|
168 |
Link.__init__(self,name,title) |
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
169 |
|
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
170 |
self.description = Markup(core.publish_string(cls.__doc__,writer=_w)) |
|
77
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
76
diff
changeset
|
171 |
|
| 72 | 172 |
|
173 |
def main(): |
|
174 |
sites=[Site("index.html","Iro"), |
|
175 |
Site("current.html","API Documentation"), |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
176 |
Site("database.html","Datenbase Schema"), |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
177 |
Site("about.html","About us"), |
| 72 | 178 |
] |
179 |
||
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
180 |
current_methods = dict(inspect.getmembers(Current())) |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
181 |
current=[ Method(i,current_methods) for i in Current().listMethods() if i != "listMethods" ] |
|
77
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
76
diff
changeset
|
182 |
|
|
251
3caa803a2dec
getting corresbonding table classes out of schema
Sandro Knauß <knauss@netzguerilla.net>
parents:
250
diff
changeset
|
183 |
t = [Table(tables_cls[str(f)]) for f in tables] |
|
77
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
76
diff
changeset
|
184 |
createSchemaPlot('doc/images/db-schema.svg') |
| 73 | 185 |
|
| 72 | 186 |
for site in sites: |
187 |
print("generiere %s" % site.name) |
|
188 |
tmpl = loader.load(site.name) |
|
189 |
def a(s): |
|
190 |
if s == site: |
|
191 |
return {"class":"menu active"} |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
192 |
stream = tmpl.generate(sites=sites, active=a, current=current, tables=t) |
| 72 | 193 |
with open('doc/'+site.name, "w") as g: |
194 |
g.write(stream.render('html', doctype='html')) |
|
195 |
||
196 |
if __name__ == '__main__': |
|
197 |
main() |