summaryrefslogtreecommitdiff
path: root/doc/build/compile_docstrings.py
blob: fdc3bd672ed6569410908bbd768ea393a2c34dbd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
import cPickle as pickle
import sys, os

sys.path = ['../../lib', './lib/'] + sys.path

import docstring

import sqlalchemy.schema as schema
import sqlalchemy.engine as engine
import sqlalchemy.engine.strategies as strategies
import sqlalchemy.sql as sql
import sqlalchemy.pool as pool
import sqlalchemy.orm as orm
import sqlalchemy.exceptions as exceptions
import sqlalchemy.ext.proxy as proxy
import sqlalchemy.ext.sessioncontext as sessioncontext
import sqlalchemy.mods.threadlocal as threadlocal
import sqlalchemy.ext.selectresults as selectresults

objects = []
def make_doc(obj, classes=None, functions=None):
    objects.append(docstring.ObjectDoc(obj, classes=classes, functions=functions))

# basically, if you see make_doc(obj=XXX) and thats it, we have separated out the public interface.  otherwise
# still a work in progress.    
make_doc(obj=sql)
make_doc(obj=schema)
make_doc(obj=engine)
make_doc(obj=engine.url)
make_doc(obj=orm, classes=[orm.MapperExtension])
make_doc(obj=orm.mapperlib, classes=[orm.mapperlib.Mapper, orm.mapperlib.SelectionContext])
make_doc(obj=orm.query, classes=[orm.query.Query, orm.query.QueryContext])
make_doc(obj=orm.session, classes=[orm.session.Session, orm.session.SessionTransaction])
make_doc(obj=pool, classes=[pool.DBProxy, pool.Pool, pool.QueuePool, pool.SingletonThreadPool])
make_doc(obj=sessioncontext)
make_doc(obj=threadlocal)
make_doc(obj=selectresults)
make_doc(obj=exceptions)
make_doc(obj=proxy)


output = os.path.join(os.getcwd(), 'content', "compiled_docstrings.pickle")
pickle.dump(objects, file(output, 'w'))