8855: start to update API doc for DB stuff

This commit is contained in:
romjerome
2017-02-02 10:34:18 +01:00
parent 1a1515d6e3
commit e287101688
5 changed files with 91 additions and 57 deletions

View File

@@ -11,33 +11,6 @@ GrampsDbBase
:undoc-members:
: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
====================================
.. automodule:: gramps.gen.db.txn
@@ -45,13 +18,6 @@ GrampsDbTxn
:undoc-members:
:show-inheritance:
GrampsDbUndo
====================================
.. automodule:: gramps.gen.db.undoredo
:members:
:undoc-members:
:show-inheritance:
DbConst
====================================
.. automodule:: gramps.gen.db.dbconst
@@ -64,15 +30,74 @@ GrampsDbException
:undoc-members:
:show-inheritance:
Upgrade utilities
GrampsDbUndo
====================================
.. automodule:: gramps.gen.db.upgrade
:members:
:undoc-members:
Backup
====================================
.. automodule:: gramps.gen.db.backup
.. automodule:: gramps.gen.db.undoredo
:members:
:undoc-members:
: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: