4935: update API documentation
svn: r17644
This commit is contained in:
parent
10906f43be
commit
85b57d44bb
@ -266,3 +266,14 @@ DateHandler (Swedish)
|
|||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
|
#########################################
|
||||||
|
The :class:`Date Edition` Classes
|
||||||
|
#########################################
|
||||||
|
|
||||||
|
DateEdit
|
||||||
|
====================================
|
||||||
|
.. automodule:: DateEdit
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
@ -18,31 +18,53 @@ BaseObject
|
|||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
RefBase
|
AddressBase
|
||||||
====================================
|
====================================
|
||||||
.. automodule:: gen.lib.refbase
|
.. automodule:: gen.lib.addressbase
|
||||||
.. autoclass:: RefBase
|
.. autoclass:: AddressBase
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
PrivacyBase
|
AttributeBase
|
||||||
====================================
|
====================================
|
||||||
.. automodule:: gen.lib.privacybase
|
.. automodule:: gen.lib.attrbase
|
||||||
.. autoclass:: PrivacyBase
|
.. autoclass:: AttributeBase
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
|
DateBase
|
||||||
SourceBase
|
|
||||||
====================================
|
====================================
|
||||||
.. automodule:: gen.lib.srcbase
|
.. automodule:: gen.lib.datebase
|
||||||
.. autoclass:: SourceBase
|
.. autoclass:: DateBase
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
LdsOrdBase
|
||||||
|
====================================
|
||||||
|
.. automodule:: gen.lib.ldsordbase
|
||||||
|
.. autoclass:: LdsOrdBase
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
LocationBase
|
||||||
|
====================================
|
||||||
|
.. automodule:: gen.lib.locationbase
|
||||||
|
.. autoclass:: LocationBase
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
MediaBase
|
||||||
|
====================================
|
||||||
|
.. automodule:: gen.lib.mediabase
|
||||||
|
.. autoclass:: MediaBase
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
|
|
||||||
NoteBase
|
NoteBase
|
||||||
====================================
|
====================================
|
||||||
@ -52,14 +74,6 @@ NoteBase
|
|||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
MediaBase
|
|
||||||
====================================
|
|
||||||
.. automodule:: gen.lib.mediabase
|
|
||||||
.. autoclass:: MediaBase
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
||||||
PlaceBase
|
PlaceBase
|
||||||
====================================
|
====================================
|
||||||
.. automodule:: gen.lib.placebase
|
.. automodule:: gen.lib.placebase
|
||||||
@ -68,29 +82,26 @@ PlaceBase
|
|||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
|
PrivacyBase
|
||||||
LocationBase
|
|
||||||
====================================
|
====================================
|
||||||
.. automodule:: gen.lib.locationbase
|
.. automodule:: gen.lib.privacybase
|
||||||
.. autoclass:: LocationBase
|
.. autoclass:: PrivacyBase
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
RefBase
|
||||||
|
====================================
|
||||||
|
.. automodule:: gen.lib.refbase
|
||||||
|
.. autoclass:: RefBase
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
|
SourceBase
|
||||||
AddressBase
|
|
||||||
====================================
|
====================================
|
||||||
.. automodule:: gen.lib.addressbase
|
.. automodule:: gen.lib.srcbase
|
||||||
.. autoclass:: AddressBase
|
.. autoclass:: SourceBase
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
||||||
|
|
||||||
AttributeBase
|
|
||||||
====================================
|
|
||||||
.. automodule:: gen.lib.attrbase
|
|
||||||
.. autoclass:: AttributeBase
|
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
@ -102,11 +113,11 @@ SurnameBase
|
|||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
DateBase
|
TagBase
|
||||||
====================================
|
====================================
|
||||||
.. automodule:: gen.lib.datebase
|
.. automodule:: gen.lib.tagbase
|
||||||
.. autoclass:: DateBase
|
.. autoclass:: TagBase
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
@ -119,14 +130,6 @@ UrlBase
|
|||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
LdsOrdBase
|
|
||||||
====================================
|
|
||||||
.. automodule:: gen.lib.ldsordbase
|
|
||||||
.. autoclass:: LdsOrdBase
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
||||||
*****************************
|
*****************************
|
||||||
Primary objects
|
Primary objects
|
||||||
*****************************
|
*****************************
|
||||||
@ -154,7 +157,6 @@ Person
|
|||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
|
|
||||||
Family
|
Family
|
||||||
====================================
|
====================================
|
||||||
.. automodule:: gen.lib.family
|
.. automodule:: gen.lib.family
|
||||||
@ -163,7 +165,6 @@ Family
|
|||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
|
|
||||||
Event
|
Event
|
||||||
====================================
|
====================================
|
||||||
.. automodule:: gen.lib.event
|
.. automodule:: gen.lib.event
|
||||||
@ -180,7 +181,6 @@ Place
|
|||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
|
|
||||||
Source
|
Source
|
||||||
====================================
|
====================================
|
||||||
.. automodule:: gen.lib.src
|
.. automodule:: gen.lib.src
|
||||||
@ -189,7 +189,6 @@ Source
|
|||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
|
|
||||||
Media Object
|
Media Object
|
||||||
====================================
|
====================================
|
||||||
.. automodule:: gen.lib.mediaobj
|
.. automodule:: gen.lib.mediaobj
|
||||||
@ -198,7 +197,6 @@ Media Object
|
|||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
|
|
||||||
Repository
|
Repository
|
||||||
====================================
|
====================================
|
||||||
.. automodule:: gen.lib.repo
|
.. automodule:: gen.lib.repo
|
||||||
@ -227,7 +225,6 @@ Secondary Object
|
|||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
|
|
||||||
Address
|
Address
|
||||||
====================================
|
====================================
|
||||||
.. automodule:: gen.lib.address
|
.. automodule:: gen.lib.address
|
||||||
@ -236,14 +233,6 @@ Address
|
|||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
Location
|
|
||||||
====================================
|
|
||||||
.. automodule:: gen.lib.location
|
|
||||||
.. autoclass:: Location
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
||||||
Attribute
|
Attribute
|
||||||
====================================
|
====================================
|
||||||
.. automodule:: gen.lib.attribute
|
.. automodule:: gen.lib.attribute
|
||||||
@ -260,6 +249,14 @@ LdsOrd
|
|||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
|
Location
|
||||||
|
====================================
|
||||||
|
.. automodule:: gen.lib.location
|
||||||
|
.. autoclass:: Location
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
Name
|
Name
|
||||||
====================================
|
====================================
|
||||||
.. automodule:: gen.lib.name
|
.. automodule:: gen.lib.name
|
||||||
@ -284,19 +281,10 @@ Url
|
|||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
|
|
||||||
*****************************
|
*****************************
|
||||||
Reference objects
|
Reference objects
|
||||||
*****************************
|
*****************************
|
||||||
|
|
||||||
PersonRef
|
|
||||||
====================================
|
|
||||||
.. automodule:: gen.lib.personref
|
|
||||||
.. autoclass:: PersonRef
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
||||||
ChildRef
|
ChildRef
|
||||||
====================================
|
====================================
|
||||||
.. automodule:: gen.lib.childref
|
.. automodule:: gen.lib.childref
|
||||||
@ -321,10 +309,10 @@ MediaRef
|
|||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
SourceRef
|
PersonRef
|
||||||
====================================
|
====================================
|
||||||
.. automodule:: gen.lib.srcref
|
.. automodule:: gen.lib.personref
|
||||||
.. autoclass:: SourceRef
|
.. autoclass:: PersonRef
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
@ -336,6 +324,25 @@ RepoRef
|
|||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
|
SourceRef
|
||||||
|
====================================
|
||||||
|
.. automodule:: gen.lib.srcref
|
||||||
|
.. autoclass:: SourceRef
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
*****************************
|
||||||
|
Table object
|
||||||
|
*****************************
|
||||||
|
|
||||||
|
Table object
|
||||||
|
====================================
|
||||||
|
.. automodule:: gen.lib.tableobj
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
*****************************
|
*****************************
|
||||||
Date objects
|
Date objects
|
||||||
@ -417,20 +424,6 @@ GrampsType
|
|||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
NameType
|
|
||||||
===========
|
|
||||||
.. automodule:: gen.lib.nametype
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
||||||
NameOriginType
|
|
||||||
===========
|
|
||||||
.. automodule:: gen.lib.nameorigintype
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
||||||
AttributeType
|
AttributeType
|
||||||
=============
|
=============
|
||||||
.. automodule:: gen.lib.attrtype
|
.. automodule:: gen.lib.attrtype
|
||||||
@ -438,13 +431,6 @@ AttributeType
|
|||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
UrlType
|
|
||||||
========
|
|
||||||
.. automodule:: gen.lib.urltype
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
||||||
ChildRefType
|
ChildRefType
|
||||||
=============
|
=============
|
||||||
.. automodule:: gen.lib.childreftype
|
.. automodule:: gen.lib.childreftype
|
||||||
@ -452,13 +438,6 @@ ChildRefType
|
|||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
RepositoryType
|
|
||||||
==============
|
|
||||||
.. automodule:: gen.lib.repotype
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
||||||
EventType
|
EventType
|
||||||
===========
|
===========
|
||||||
.. automodule:: gen.lib.eventtype
|
.. automodule:: gen.lib.eventtype
|
||||||
@ -466,6 +445,13 @@ EventType
|
|||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
|
EventRoleType
|
||||||
|
==============
|
||||||
|
.. automodule:: gen.lib.eventroletype
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
FamilyRelType
|
FamilyRelType
|
||||||
=============
|
=============
|
||||||
@ -474,20 +460,6 @@ FamilyRelType
|
|||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
SourceMediaType
|
|
||||||
================
|
|
||||||
.. automodule:: gen.lib.srcmediatype
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
||||||
EventRoleType
|
|
||||||
==============
|
|
||||||
.. automodule:: gen.lib.eventroletype
|
|
||||||
:members:
|
|
||||||
:undoc-members:
|
|
||||||
:show-inheritance:
|
|
||||||
|
|
||||||
MarkerType
|
MarkerType
|
||||||
==========
|
==========
|
||||||
.. automodule:: gen.lib.markertype
|
.. automodule:: gen.lib.markertype
|
||||||
@ -495,6 +467,20 @@ MarkerType
|
|||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
|
NameType
|
||||||
|
===========
|
||||||
|
.. automodule:: gen.lib.nametype
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
NameOriginType
|
||||||
|
==============
|
||||||
|
.. automodule:: gen.lib.nameorigintype
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
NoteType
|
NoteType
|
||||||
=========
|
=========
|
||||||
.. automodule:: gen.lib.notetype
|
.. automodule:: gen.lib.notetype
|
||||||
@ -502,11 +488,30 @@ NoteType
|
|||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
|
RepositoryType
|
||||||
|
==============
|
||||||
|
.. automodule:: gen.lib.repotype
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
|
SourceMediaType
|
||||||
|
================
|
||||||
|
.. automodule:: gen.lib.srcmediatype
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
|
||||||
StyledTextTagType
|
StyledTextTagType
|
||||||
==================
|
==================
|
||||||
.. automodule:: gen.lib.styledtexttagtype
|
.. automodule:: gen.lib.styledtexttagtype
|
||||||
:members:
|
:members:
|
||||||
:undoc-members:
|
:undoc-members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
|
|
||||||
|
UrlType
|
||||||
|
========
|
||||||
|
.. automodule:: gen.lib.urltype
|
||||||
|
:members:
|
||||||
|
:undoc-members:
|
||||||
|
:show-inheritance:
|
||||||
|
Loading…
Reference in New Issue
Block a user