| author | Sandro Knauß <knauss@netzguerilla.net> |
| Thu, 27 Sep 2012 17:18:06 +0200 | |
| branch | devel |
| changeset 305 | 887ca66823bb |
| parent 294 | 0e75bd39767d |
| child 312 | 42fd5075a5d1 |
| permissions | -rwxr-xr-x |
| 72 | 1 |
#!/usr/bin/env python2.7 |
|
294
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
281
diff
changeset
|
2 |
|
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
281
diff
changeset
|
3 |
# Copyright (c) 2012 netzguerilla.net <iro@netzguerilla.net> |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
281
diff
changeset
|
4 |
# |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
281
diff
changeset
|
5 |
# This file is part of Iro. |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
281
diff
changeset
|
6 |
# |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
281
diff
changeset
|
7 |
# Permission is hereby granted, free of charge, to any person obtaining a copy of |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
281
diff
changeset
|
8 |
# this software and associated documentation files (the "Software"), to deal in |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
281
diff
changeset
|
9 |
# the Software without restriction, including without limitation the rights to use, |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
281
diff
changeset
|
10 |
# copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
281
diff
changeset
|
11 |
# #Software, and to permit persons to whom the Software is furnished to do so, |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
281
diff
changeset
|
12 |
# subject to the following conditions: |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
281
diff
changeset
|
13 |
# |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
281
diff
changeset
|
14 |
# The above copyright notice and this permission notice shall be included in |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
281
diff
changeset
|
15 |
# all copies or substantial portions of the Software. |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
281
diff
changeset
|
16 |
# |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
281
diff
changeset
|
17 |
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
281
diff
changeset
|
18 |
# INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
281
diff
changeset
|
19 |
# PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
281
diff
changeset
|
20 |
# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
281
diff
changeset
|
21 |
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
281
diff
changeset
|
22 |
# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
|
0e75bd39767d
adding LICENSE to all files
Sandro Knauß <knauss@netzguerilla.net>
parents:
281
diff
changeset
|
23 |
|
| 72 | 24 |
# -*- coding: utf-8 -*- |
25 |
||
26 |
from genshi.template import TemplateLoader |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
27 |
from genshi import Markup |
| 72 | 28 |
loader = TemplateLoader('doc/tmpl', auto_reload=True) |
29 |
||
|
277
f65edc0382cc
prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents:
271
diff
changeset
|
30 |
|
|
f65edc0382cc
prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents:
271
diff
changeset
|
31 |
from glob import glob |
|
f65edc0382cc
prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents:
271
diff
changeset
|
32 |
import re |
|
f65edc0382cc
prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents:
271
diff
changeset
|
33 |
import os.path |
| 72 | 34 |
import inspect |
|
277
f65edc0382cc
prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents:
271
diff
changeset
|
35 |
from pkg_resources import parse_version |
|
f65edc0382cc
prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents:
271
diff
changeset
|
36 |
|
|
281
76572d14bd27
createdoc.py: cleaning up
Sandro Knauß <knauss@netzguerilla.net>
parents:
277
diff
changeset
|
37 |
from docutils.core import publish_doctree, publish_from_doctree, publish_string |
|
76572d14bd27
createdoc.py: cleaning up
Sandro Knauß <knauss@netzguerilla.net>
parents:
277
diff
changeset
|
38 |
from docutils.utils import new_document |
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
39 |
from docutils.writers.html4css1 import Writer,HTMLTranslator |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
40 |
|
|
277
f65edc0382cc
prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents:
271
diff
changeset
|
41 |
from iro.view.xmlrpc import TwistedInterface as Current |
|
f65edc0382cc
prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents:
271
diff
changeset
|
42 |
from iro import __version__ |
|
f65edc0382cc
prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents:
271
diff
changeset
|
43 |
from createerm import createSchemaPlot, tables, tables_cls |
|
f65edc0382cc
prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents:
271
diff
changeset
|
44 |
|
|
281
76572d14bd27
createdoc.py: cleaning up
Sandro Knauß <knauss@netzguerilla.net>
parents:
277
diff
changeset
|
45 |
#redering text with rest syntax |
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
46 |
class NoHeaderHTMLTranslator(HTMLTranslator): |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
47 |
def __init__(self, document): |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
48 |
HTMLTranslator.__init__(self,document) |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
49 |
self.body_prefix = [] |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
50 |
self.body_suffix = [] |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
51 |
|
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
52 |
_w = Writer() |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
53 |
_w.translator_class = NoHeaderHTMLTranslator |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
54 |
_w.visitor_attributes = ("html_body",) |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
55 |
|
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
56 |
def d(): |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
57 |
subs = _w.interpolation_dict() |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
58 |
return "%(html_body)s"%subs |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
59 |
|
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
60 |
_w.apply_template = d |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
61 |
|
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
62 |
def reSTify(s): |
|
281
76572d14bd27
createdoc.py: cleaning up
Sandro Knauß <knauss@netzguerilla.net>
parents:
277
diff
changeset
|
63 |
d = new_document("") |
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
64 |
if s.tagname == "paragraph": |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
65 |
d.append(s[0]) |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
66 |
else: |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
67 |
d.append(s) |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
68 |
|
|
281
76572d14bd27
createdoc.py: cleaning up
Sandro Knauß <knauss@netzguerilla.net>
parents:
277
diff
changeset
|
69 |
return publish_from_doctree(d, writer=_w) |
|
76572d14bd27
createdoc.py: cleaning up
Sandro Knauß <knauss@netzguerilla.net>
parents:
277
diff
changeset
|
70 |
|
|
76572d14bd27
createdoc.py: cleaning up
Sandro Knauß <knauss@netzguerilla.net>
parents:
277
diff
changeset
|
71 |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
72 |
|
|
76
9f7da8dc8df8
using decode('utf8') to get docstrings.
Sandro Knauß <knauss@netzguerilla.net>
parents:
74
diff
changeset
|
73 |
|
| 72 | 74 |
class Link(): |
75 |
def __init__(self,name,title): |
|
76 |
self.name=name |
|
77 |
self.title=title |
|
78 |
||
79 |
def getLink(self): |
|
80 |
return self.name |
|
81 |
||
82 |
def __getitem__(self,name): |
|
83 |
if name == "link": |
|
84 |
return self.getLink() |
|
85 |
return AttributeError(name) |
|
86 |
||
87 |
class Site(Link): |
|
88 |
pass |
|
89 |
||
|
281
76572d14bd27
createdoc.py: cleaning up
Sandro Knauß <knauss@netzguerilla.net>
parents:
277
diff
changeset
|
90 |
|
| 72 | 91 |
class Keyword(): |
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
92 |
def __init__(self, name=None, typ=None, description=None): |
| 72 | 93 |
self.name=name |
94 |
self.typ=typ |
|
95 |
self.description=description |
|
96 |
||
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
97 |
def __repr__(self): |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
98 |
return '<Keyword("%s", "%s", "%s")>'%(self.name, self.typ, self.description) |
| 72 | 99 |
|
100 |
def keywords(f): |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
101 |
NORMAL = 0 |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
102 |
TYPE = 1 |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
103 |
pd = publish_doctree(f.__doc__.decode('utf8')) |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
104 |
|
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
105 |
kws={} |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
106 |
for child in pd[1][0]: |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
107 |
kw = Keyword() |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
108 |
ftyp = NORMAL |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
109 |
for sc in child: |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
110 |
if sc.tagname == "field_name": |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
111 |
p = sc.astext().split() |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
112 |
if p[0] in ["param",]: |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
113 |
if len(p) == 3: #param typ name |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
114 |
kw.name = p[2] |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
115 |
kw.typ = p[1] |
|
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.name = p[1] |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
118 |
elif p[0] == "type": |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
119 |
kw = kws[p[1]] |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
120 |
ftyp=TYPE |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
121 |
elif p[0] in ["return","rtyp"]: |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
122 |
break |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
123 |
else: |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
124 |
raise Exception("Unknown field_name: %s"%(p[0])) |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
125 |
if sc.tagname == "field_body": |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
126 |
if ftyp == NORMAL: |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
127 |
kw.description = Markup(reSTify(sc[0])) |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
128 |
if ftyp == TYPE: |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
129 |
kw.typ = sc[0][0] |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
130 |
else: |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
131 |
kws[kw.name] = kw |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
132 |
return kws |
| 72 | 133 |
|
134 |
def ret(f): |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
135 |
NORMAL = 0 |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
136 |
TYPE = 1 |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
137 |
|
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
138 |
pd = publish_doctree(f.__doc__.decode('utf8')) |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
139 |
for child in pd[1][0]: |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
140 |
kw = Keyword(name="return") |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
141 |
ftyp = NORMAL |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
142 |
for sc in child: |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
143 |
if sc.tagname == "field_name": |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
144 |
p = sc.astext().split() |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
145 |
if p[0] == "return": |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
146 |
if len(p) == 2: |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
147 |
kw.typ = p[1] |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
148 |
elif p[0] == "rtype": |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
149 |
ftyp=TYPE |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
150 |
elif p[0] in ["param","type"]: |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
151 |
break |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
152 |
else: |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
153 |
raise Exception("Unknown field_name: %s"%(p[0])) |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
154 |
if sc.tagname == "field_body": |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
155 |
if ftyp == NORMAL: |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
156 |
kw.description = Markup(reSTify(sc[0])) |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
157 |
if ftyp == TYPE: |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
158 |
kw.typ = sc[0][0] |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
159 |
else: |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
160 |
return kw |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
161 |
|
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
162 |
raise Exception("no return description") |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
163 |
|
| 72 | 164 |
class Arg(): |
165 |
def __init__(self,name,f): |
|
166 |
self.name=name |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
167 |
k = keywords(f) |
| 72 | 168 |
kwd=k[name] |
169 |
self.typ=kwd.typ |
|
170 |
self.description=kwd.description |
|
171 |
||
172 |
class Method(Link): |
|
| 73 | 173 |
def __init__(self,name,methods): |
174 |
title=name[0].upper()+name[1:] |
|
| 72 | 175 |
Link.__init__(self,name,title) |
| 73 | 176 |
m=methods[name] |
|
74
c471fed3cab8
update document creation:
Sandro Knauß <knauss@netzguerilla.net>
parents:
73
diff
changeset
|
177 |
(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
|
178 |
a=[] |
|
91890ea7ed81
update docstrings in iro.controller.viewinterface for createdoc
Sandro Knauß <knauss@netzguerilla.net>
parents:
92
diff
changeset
|
179 |
for b in args: |
|
91890ea7ed81
update docstrings in iro.controller.viewinterface for createdoc
Sandro Knauß <knauss@netzguerilla.net>
parents:
92
diff
changeset
|
180 |
if b in ("self","session"): |
|
91890ea7ed81
update docstrings in iro.controller.viewinterface for createdoc
Sandro Knauß <knauss@netzguerilla.net>
parents:
92
diff
changeset
|
181 |
continue |
|
91890ea7ed81
update docstrings in iro.controller.viewinterface for createdoc
Sandro Knauß <knauss@netzguerilla.net>
parents:
92
diff
changeset
|
182 |
else: |
|
91890ea7ed81
update docstrings in iro.controller.viewinterface for createdoc
Sandro Knauß <knauss@netzguerilla.net>
parents:
92
diff
changeset
|
183 |
a.append(b) |
|
91890ea7ed81
update docstrings in iro.controller.viewinterface for createdoc
Sandro Knauß <knauss@netzguerilla.net>
parents:
92
diff
changeset
|
184 |
|
|
91890ea7ed81
update docstrings in iro.controller.viewinterface for createdoc
Sandro Knauß <knauss@netzguerilla.net>
parents:
92
diff
changeset
|
185 |
args = a |
|
74
c471fed3cab8
update document creation:
Sandro Knauß <knauss@netzguerilla.net>
parents:
73
diff
changeset
|
186 |
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
|
187 |
pd = publish_doctree(m.__doc__) |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
188 |
if pd[0].tagname == "paragraph": |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
189 |
self.description = pd[0].astext() |
|
74
c471fed3cab8
update document creation:
Sandro Knauß <knauss@netzguerilla.net>
parents:
73
diff
changeset
|
190 |
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
|
191 |
self.rets=[ret(m)] |
| 72 | 192 |
|
|
77
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
76
diff
changeset
|
193 |
class Table(Link): |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
76
diff
changeset
|
194 |
def __init__(self,cls): |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
76
diff
changeset
|
195 |
name=cls.__name__ |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
76
diff
changeset
|
196 |
self.tablename=cls.__tablename__ |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
76
diff
changeset
|
197 |
title=self.tablename[0].upper()+self.tablename[1:] |
|
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
76
diff
changeset
|
198 |
Link.__init__(self,name,title) |
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
199 |
|
|
281
76572d14bd27
createdoc.py: cleaning up
Sandro Knauß <knauss@netzguerilla.net>
parents:
277
diff
changeset
|
200 |
self.description = Markup(publish_string(cls.__doc__,writer=_w)) |
|
77
7dce6c0f06fb
adding database schema to documentation.
Sandro Knauß <knauss@netzguerilla.net>
parents:
76
diff
changeset
|
201 |
|
|
277
f65edc0382cc
prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents:
271
diff
changeset
|
202 |
class File: |
|
f65edc0382cc
prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents:
271
diff
changeset
|
203 |
def __init__(self,path): |
|
f65edc0382cc
prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents:
271
diff
changeset
|
204 |
self.version = re.search("/iro-(.*).tar.gz",path).group(1) |
|
f65edc0382cc
prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents:
271
diff
changeset
|
205 |
self.name = os.path.basename(path) |
|
f65edc0382cc
prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents:
271
diff
changeset
|
206 |
|
| 72 | 207 |
|
208 |
def main(): |
|
209 |
sites=[Site("index.html","Iro"), |
|
210 |
Site("current.html","API Documentation"), |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
211 |
Site("database.html","Datenbase Schema"), |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
212 |
Site("about.html","About us"), |
| 72 | 213 |
] |
214 |
||
|
277
f65edc0382cc
prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents:
271
diff
changeset
|
215 |
files=[File(f) for f in glob("web/files/*tar.gz")] |
|
f65edc0382cc
prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents:
271
diff
changeset
|
216 |
files.sort(key=lambda a:parse_version(a.version),reverse=True) |
|
f65edc0382cc
prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents:
271
diff
changeset
|
217 |
code ="files/iro-%s.tar.gz"%__version__ |
|
f65edc0382cc
prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents:
271
diff
changeset
|
218 |
|
|
271
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
219 |
current_methods = dict(inspect.getmembers(Current())) |
|
b218238e76b9
creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents:
251
diff
changeset
|
220 |
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
|
221 |
|
|
251
3caa803a2dec
getting corresbonding table classes out of schema
Sandro Knauß <knauss@netzguerilla.net>
parents:
250
diff
changeset
|
222 |
t = [Table(tables_cls[str(f)]) for f in tables] |
|
277
f65edc0382cc
prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents:
271
diff
changeset
|
223 |
createSchemaPlot('web/images/db-schema.svg') |
|
f65edc0382cc
prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents:
271
diff
changeset
|
224 |
|
|
f65edc0382cc
prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents:
271
diff
changeset
|
225 |
gd = {"sites":sites, |
|
f65edc0382cc
prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents:
271
diff
changeset
|
226 |
"current":current, |
|
f65edc0382cc
prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents:
271
diff
changeset
|
227 |
"tables": t, |
|
f65edc0382cc
prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents:
271
diff
changeset
|
228 |
"code":code, |
|
f65edc0382cc
prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents:
271
diff
changeset
|
229 |
"files":files |
|
f65edc0382cc
prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents:
271
diff
changeset
|
230 |
} |
| 73 | 231 |
|
| 72 | 232 |
for site in sites: |
233 |
print("generiere %s" % site.name) |
|
234 |
tmpl = loader.load(site.name) |
|
235 |
def a(s): |
|
236 |
if s == site: |
|
237 |
return {"class":"menu active"} |
|
|
277
f65edc0382cc
prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents:
271
diff
changeset
|
238 |
stream = tmpl.generate(active=a, **gd) |
|
f65edc0382cc
prepare for release:
Sandro Knauß <knauss@netzguerilla.net>
parents:
271
diff
changeset
|
239 |
with open('web/'+site.name, "w") as g: |
| 72 | 240 |
g.write(stream.render('html', doctype='html')) |
241 |
||
242 |
if __name__ == '__main__': |
|
243 |
main() |