createdoc.py
author Sandro Knauß <bugs@sandroknauss.de>
Tue, 15 Apr 2025 01:22:19 +0200
changeset 316 63c681b8e92c
parent 312 42fd5075a5d1
permissions -rwxr-xr-x
fix link to about.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
312
Sandro Knauß <bugs@sandroknauss.de>
parents: 294
diff changeset
     1
#!/usr/bin/env python3
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
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    24
# -*- coding: utf-8 -*- 
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    25
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    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
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    28
loader = TemplateLoader('doc/tmpl', auto_reload=True)
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    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
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    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
312
Sandro Knauß <bugs@sandroknauss.de>
parents: 294
diff changeset
    41
from iro.view.xmlrpc import TwistedInterface as Current
277
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
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    74
class Link():
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    75
    def __init__(self,name,title):
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    76
        self.name=name
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    77
        self.title=title
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    78
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    79
    def getLink(self):
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    80
        return self.name
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    81
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    82
    def __getitem__(self,name):
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    83
        if name == "link":
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    84
            return self.getLink()
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    85
        return AttributeError(name)
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    86
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    87
class Site(Link):
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    88
    pass
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    89
281
76572d14bd27 createdoc.py: cleaning up
Sandro Knauß <knauss@netzguerilla.net>
parents: 277
diff changeset
    90
72
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    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
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    93
        self.name=name
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    94
        self.typ=typ
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    95
        self.description=description
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    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
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    99
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   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
312
Sandro Knauß <bugs@sandroknauss.de>
parents: 294
diff changeset
   103
    pd = publish_doctree(f.__doc__)
271
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={}
312
Sandro Knauß <bugs@sandroknauss.de>
parents: 294
diff changeset
   106
    for child in pd[1]:
271
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:
312
Sandro Knauß <bugs@sandroknauss.de>
parents: 294
diff changeset
   127
                    kw.description = Markup(reSTify(sc[0]).decode())
271
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
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   133
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   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
312
Sandro Knauß <bugs@sandroknauss.de>
parents: 294
diff changeset
   137
Sandro Knauß <bugs@sandroknauss.de>
parents: 294
diff changeset
   138
    pd = publish_doctree(f.__doc__)
Sandro Knauß <bugs@sandroknauss.de>
parents: 294
diff changeset
   139
    for child in pd[1]:
271
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:
312
Sandro Knauß <bugs@sandroknauss.de>
parents: 294
diff changeset
   156
                    kw.description = Markup(reSTify(sc[0]).decode())
271
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 251
diff changeset
   157
        else:
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 251
diff changeset
   158
            return kw
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 251
diff changeset
   159
    
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 251
diff changeset
   160
    raise Exception("no return description")
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 251
diff changeset
   161
 
72
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   162
class Arg():
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   163
    def __init__(self,name,f):
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   164
        self.name=name
271
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 251
diff changeset
   165
        k = keywords(f)
72
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   166
        kwd=k[name]
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   167
        self.typ=kwd.typ
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   168
        self.description=kwd.description
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   169
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   170
class Method(Link):
73
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents: 72
diff changeset
   171
    def __init__(self,name,methods):
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents: 72
diff changeset
   172
        title=name[0].upper()+name[1:]
72
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   173
        Link.__init__(self,name,title)
73
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents: 72
diff changeset
   174
        m=methods[name]
312
Sandro Knauß <bugs@sandroknauss.de>
parents: 294
diff changeset
   175
Sandro Knauß <bugs@sandroknauss.de>
parents: 294
diff changeset
   176
        signature=inspect.signature(m)
Sandro Knauß <bugs@sandroknauss.de>
parents: 294
diff changeset
   177
Sandro Knauß <bugs@sandroknauss.de>
parents: 294
diff changeset
   178
        parameters = signature.parameters.copy()
Sandro Knauß <bugs@sandroknauss.de>
parents: 294
diff changeset
   179
Sandro Knauß <bugs@sandroknauss.de>
parents: 294
diff changeset
   180
        for arg in ("self", "session"):
Sandro Knauß <bugs@sandroknauss.de>
parents: 294
diff changeset
   181
            try:
Sandro Knauß <bugs@sandroknauss.de>
parents: 294
diff changeset
   182
                del(parameters[arg])
Sandro Knauß <bugs@sandroknauss.de>
parents: 294
diff changeset
   183
            except KeyError:
Sandro Knauß <bugs@sandroknauss.de>
parents: 294
diff changeset
   184
                pass
Sandro Knauß <bugs@sandroknauss.de>
parents: 294
diff changeset
   185
Sandro Knauß <bugs@sandroknauss.de>
parents: 294
diff changeset
   186
        self.func_line=str(signature.replace(parameters=parameters.values()))
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()
312
Sandro Knauß <bugs@sandroknauss.de>
parents: 294
diff changeset
   190
        self.args=[Arg(a,m) for a in parameters]
271
b218238e76b9 creadoc: switching to rst syntax
Sandro Knauß <knauss@netzguerilla.net>
parents: 251
diff changeset
   191
        self.rets=[ret(m)]
72
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   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
        
312
Sandro Knauß <bugs@sandroknauss.de>
parents: 294
diff changeset
   200
        self.description = Markup(publish_string(cls.__doc__,writer=_w).decode())
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
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   207
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   208
def main():
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   209
    sites=[Site("index.html","Iro"),
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   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
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   213
           ]
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   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
f2f247a5b6c9 update Documentation
Sandro Knauß <knauss@netzguerilla.net>
parents: 72
diff changeset
   231
72
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   232
    for site in sites:
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   233
        print("generiere %s" % site.name)
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   234
        tmpl = loader.load(site.name)
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   235
        def a(s):
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   236
            if s == site:
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   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
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   240
            g.write(stream.render('html', doctype='html'))
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   241
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   242
if __name__ == '__main__':
e7b44716a564 adding documentation
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
   243
    main()