8855: start to update API doc for DB stuff
This commit is contained in:
parent
1a1515d6e3
commit
e287101688
@ -11,33 +11,6 @@ GrampsDbBase
|
|||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
GrampsDbRead
|
|
||||||
====================================
|
|
||||||
.. automodule:: gramps.gen.db.read
|
|
||||||
:members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
||||||
GrampsDbWrite
|
|
||||||
====================================
|
|
||||||
.. automodule:: gramps.gen.db.write
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
||||||
GrampsCursor
|
|
||||||
====================================
|
|
||||||
.. automodule:: gramps.gen.db.cursor
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
||||||
BSDDBtxn
|
|
||||||
====================================
|
|
||||||
.. automodule:: gramps.gen.db.bsddbtxn
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
||||||
GrampsDbTxn
|
GrampsDbTxn
|
||||||
====================================
|
====================================
|
||||||
.. automodule:: gramps.gen.db.txn
|
.. automodule:: gramps.gen.db.txn
|
||||||
@ -45,13 +18,6 @@ GrampsDbTxn
|
|||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
GrampsDbUndo
|
|
||||||
====================================
|
|
||||||
.. automodule:: gramps.gen.db.undoredo
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
||||||
DbConst
|
DbConst
|
||||||
====================================
|
====================================
|
||||||
.. automodule:: gramps.gen.db.dbconst
|
.. automodule:: gramps.gen.db.dbconst
|
||||||
@ -64,15 +30,74 @@ GrampsDbException
|
|||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
Upgrade utilities
|
GrampsDbUndo
|
||||||
====================================
|
====================================
|
||||||
.. automodule:: gramps.gen.db.upgrade
|
.. automodule:: gramps.gen.db.undoredo
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
|
|
||||||
Backup
|
|
||||||
====================================
|
|
||||||
.. automodule:: gramps.gen.db.backup
|
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
|
Generic
|
||||||
|
====================================
|
||||||
|
.. automodule:: gramps.gen.db.generic
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
DummyDb
|
||||||
|
====================================
|
||||||
|
.. automodule:: gramps.plugins.db.dummydb
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
#####################################
|
||||||
|
The :mod:`gramps.gen.db` bsddb Module
|
||||||
|
#####################################
|
||||||
|
|
||||||
|
.. automodule:: gramps.plugins.db.bsddb
|
||||||
|
|
||||||
|
GrampsDbRead
|
||||||
|
====================================
|
||||||
|
.. automodule:: gramps.plugins.db.bsddb.read
|
||||||
|
:members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
GrampsDbWrite
|
||||||
|
====================================
|
||||||
|
.. automodule:: gramps.plugins.db.bsddb.write
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
GrampsCursor
|
||||||
|
====================================
|
||||||
|
.. automodule:: gramps.plugins.db.bsddb.cursor
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
BSDDBtxn
|
||||||
|
====================================
|
||||||
|
.. automodule:: gramps.plugins.db.bsddb.bsddbtxn
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
#####################################
|
||||||
|
The :mod:`gramps.gen.db` dbapi Module
|
||||||
|
#####################################
|
||||||
|
|
||||||
|
.. automodule:: gramps.plugins.db.dbapi
|
||||||
|
|
||||||
|
DBAPI
|
||||||
|
====================================
|
||||||
|
.. automodule:: gramps.plugins.db.dbapi.dbapi
|
||||||
|
:members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
Sqlite
|
||||||
|
====================================
|
||||||
|
.. automodule:: gramps.plugins.db.dbapi.sqlite
|
||||||
|
:members:
|
||||||
|
:show-inheritance:
|
||||||
|
@ -10,3 +10,10 @@ Name
|
|||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
|
Place
|
||||||
|
====================================
|
||||||
|
.. automodule:: gramps.gen.display.place
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
@ -216,7 +216,7 @@ Citation
|
|||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
Media Object
|
Media
|
||||||
====================================
|
====================================
|
||||||
.. automodule:: gramps.gen.lib.media
|
.. automodule:: gramps.gen.lib.media
|
||||||
.. autoclass:: Media
|
.. autoclass:: Media
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
#! /usr/bin/env python
|
#! /usr/bin/env python3
|
||||||
#
|
#
|
||||||
# update_po - a gramps tool to update translations
|
# update_po - a gramps tool to update translations
|
||||||
#
|
#
|
||||||
@ -102,8 +102,9 @@ def build():
|
|||||||
# testing stage
|
# testing stage
|
||||||
|
|
||||||
os.system('''%(program)s -b html . _build/html''' % {'program': sphinxCmd})
|
os.system('''%(program)s -b html . _build/html''' % {'program': sphinxCmd})
|
||||||
os.system('''%(program)s -b changes . _build/changes''' % {'program': sphinxCmd})
|
#os.system('''%(program)s -b changes . _build/changes''' % {'program': sphinxCmd})
|
||||||
os.system('''%(program)s -b linkcheck . _build/linkcheck''' % {'program': sphinxCmd})
|
#os.system('''%(program)s -b linkcheck . _build/linkcheck''' % {'program': sphinxCmd})
|
||||||
|
#os.system('''%(program)s -b devhelp . _build/devhelp''' % {'program': sphinxCmd})
|
||||||
|
|
||||||
if __name__ == "__main__":
|
if __name__ == "__main__":
|
||||||
main()
|
main()
|
||||||
|
@ -70,3 +70,4 @@ from .txn import *
|
|||||||
from .exceptions import *
|
from .exceptions import *
|
||||||
from .undoredo import *
|
from .undoredo import *
|
||||||
from .utils import *
|
from .utils import *
|
||||||
|
from .generic import *
|
||||||
|
Loading…
Reference in New Issue
Block a user