4935: update API documentation

svn: r17643
This commit is contained in:
Jérôme Rapinat 2011-06-01 12:43:48 +00:00
parent 602e2c0ef2
commit 4ed7fdf52f
2 changed files with 135 additions and 119 deletions

View File

@ -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:

View File

@ -18,66 +18,6 @@ BaseObject
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
RefBase
====================================
.. automodule:: gen.lib.refbase
.. autoclass:: RefBase
:members:
:undoc-members:
:show-inheritance:
PrivacyBase
====================================
.. automodule:: gen.lib.privacybase
.. autoclass:: PrivacyBase
:members:
:undoc-members:
:show-inheritance:
SourceBase
====================================
.. automodule:: gen.lib.srcbase
.. autoclass:: SourceBase
:members:
:undoc-members:
:show-inheritance:
NoteBase
====================================
.. automodule:: gen.lib.notebase
.. autoclass:: NoteBase
:members:
:undoc-members:
:show-inheritance:
MediaBase
====================================
.. automodule:: gen.lib.mediabase
.. autoclass:: MediaBase
:members:
:undoc-members:
:show-inheritance:
PlaceBase
====================================
.. automodule:: gen.lib.placebase
.. autoclass:: PlaceBase
:members:
:undoc-members:
:show-inheritance:
LocationBase
====================================
.. automodule:: gen.lib.locationbase
.. autoclass:: LocationBase
:members:
:undoc-members:
:show-inheritance:
AddressBase AddressBase
==================================== ====================================
.. automodule:: gen.lib.addressbase .. automodule:: gen.lib.addressbase
@ -86,7 +26,6 @@ AddressBase
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
AttributeBase AttributeBase
==================================== ====================================
.. automodule:: gen.lib.attrbase .. automodule:: gen.lib.attrbase
@ -95,14 +34,6 @@ AttributeBase
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
SurnameBase
====================================
.. automodule:: gen.lib.surnamebase
.. autoclass:: SurnameBase
:members:
:undoc-members:
:show-inheritance:
DateBase DateBase
==================================== ====================================
.. automodule:: gen.lib.datebase .. automodule:: gen.lib.datebase
@ -111,14 +42,6 @@ DateBase
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
UrlBase
====================================
.. automodule:: gen.lib.urlbase
.. autoclass:: UrlBase
:members:
:undoc-members:
:show-inheritance:
LdsOrdBase LdsOrdBase
==================================== ====================================
.. automodule:: gen.lib.ldsordbase .. automodule:: gen.lib.ldsordbase
@ -127,6 +50,86 @@ LdsOrdBase
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
LocationBase
====================================
.. automodule:: gen.lib.locationbase
.. autoclass:: LocationBase
:members:
:undoc-members:
:show-inheritance:
MediaBase
====================================
.. automodule:: gen.lib.mediabase
.. autoclass:: MediaBase
:members:
:undoc-members:
:show-inheritance:
NoteBase
====================================
.. automodule:: gen.lib.notebase
.. autoclass:: NoteBase
:members:
:undoc-members:
:show-inheritance:
PlaceBase
====================================
.. automodule:: gen.lib.placebase
.. autoclass:: PlaceBase
:members:
:undoc-members:
:show-inheritance:
PrivacyBase
====================================
.. automodule:: gen.lib.privacybase
.. autoclass:: PrivacyBase
:members:
:undoc-members:
:show-inheritance:
RefBase
====================================
.. automodule:: gen.lib.refbase
.. autoclass:: RefBase
:members:
:undoc-members:
:show-inheritance:
SourceBase
====================================
.. automodule:: gen.lib.srcbase
.. autoclass:: SourceBase
:members:
:undoc-members:
:show-inheritance:
SurnameBase
====================================
.. automodule:: gen.lib.surnamebase
.. autoclass:: SurnameBase
:members:
:undoc-members:
:show-inheritance:
TagBase
====================================
.. automodule:: gen.lib.tagbase
.. autoclass:: TagBase
:members:
:undoc-members:
:show-inheritance:
UrlBase
====================================
.. automodule:: gen.lib.urlbase
.. autoclass:: UrlBase
: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:
@ -337,6 +325,25 @@ RepoRef
: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
@ -467,20 +446,6 @@ EventType
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
FamilyRelType
=============
.. automodule:: gen.lib.familyreltype
:members:
:undoc-members:
:show-inheritance:
SourceMediaType
================
.. automodule:: gen.lib.srcmediatype
:members:
:undoc-members:
:show-inheritance:
EventRoleType EventRoleType
============== ==============
.. automodule:: gen.lib.eventroletype .. automodule:: gen.lib.eventroletype
@ -488,6 +453,13 @@ EventRoleType
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
FamilyRelType
=============
.. automodule:: gen.lib.familyreltype
: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,6 +488,20 @@ 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
@ -509,4 +509,9 @@ StyledTextTagType
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
UrlType
========
.. automodule:: gen.lib.urltype
:members:
:undoc-members:
:show-inheritance: