Cyclone-Team/gramps
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

8855: start to update API doc for DB stuff

Browse Source
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

109
docs/gen/gen_db.rst
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:

7
docs/gen/gen_display.rst
View File

@ -10,3 +10,10 @@ Name
:members:
:undoc-members:
:show-inheritance:
Place
====================================
.. automodule:: gramps.gen.display.place
:members:
:undoc-members:
:show-inheritance:

24
docs/gen/gen_lib.rst
View File

@ -53,14 +53,14 @@ CitationBase
:members:
:undoc-members:
:show-inheritance:
IndirectCitationBase
====================================
.. autoclass:: IndirectCitationBase
:members:
:undoc-members:
:show-inheritance:
DateBase
====================================
.. automodule:: gramps.gen.lib.datebase
@ -68,7 +68,7 @@ DateBase
:members:
:undoc-members:
:show-inheritance:
LdsOrdBase
====================================
.. automodule:: gramps.gen.lib.ldsordbase
@ -76,7 +76,7 @@ LdsOrdBase
:members:
:undoc-members:
:show-inheritance:
LocationBase
====================================
.. automodule:: gramps.gen.lib.locationbase
@ -84,7 +84,7 @@ LocationBase
:members:
:undoc-members:
:show-inheritance:
MediaBase
====================================
.. automodule:: gramps.gen.lib.mediabase
@ -116,7 +116,7 @@ PrivacyBase
:members:
:undoc-members:
:show-inheritance:
RefBase
====================================
.. automodule:: gramps.gen.lib.refbase
@ -132,7 +132,7 @@ SurnameBase
:members:
:undoc-members:
:show-inheritance:
TagBase
====================================
.. automodule:: gramps.gen.lib.tagbase
@ -216,7 +216,7 @@ Citation
:undoc-members:
:show-inheritance:
Media Object
Media
====================================
.. automodule:: gramps.gen.lib.media
.. autoclass:: Media
@ -366,7 +366,7 @@ RepoRef
:members:
:undoc-members:
:show-inheritance:
*****************************
Table objects
*****************************
@ -487,7 +487,7 @@ EventType
:members:
:undoc-members:
:show-inheritance:
EventRoleType
==============
.. automodule:: gramps.gen.lib.eventroletype
@ -543,7 +543,7 @@ RepositoryType
:members:
:undoc-members:
:show-inheritance:
SourceMediaType
================
.. automodule:: gramps.gen.lib.srcmediatype
@ -557,7 +557,7 @@ StyledTextTagType
:members:
:undoc-members:
:show-inheritance:
UrlType
========
.. automodule:: gramps.gen.lib.urltype

7
docs/update_doc.py
View File

@ -1,4 +1,4 @@
#! /usr/bin/env python
#! /usr/bin/env python3
#
# update_po - a gramps tool to update translations
#
@ -102,8 +102,9 @@ def build():
# testing stage
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 linkcheck . _build/linkcheck''' % {'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 devhelp . _build/devhelp''' % {'program': sphinxCmd})
if __name__ == "__main__":
main()

1
gramps/gen/db/__init__.py
View File

@ -70,3 +70,4 @@ from .txn import *
from .exceptions import *
from .undoredo import *
from .utils import *
from .generic import *