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

update APIs documentation according to last changes (GEPS008)

Browse Source 
svn: r20032
This commit is contained in:
Jérôme Rapinat 2012-07-19 08:55:23 +00:00
parent 37e6616185
commit 17350a8c2f
9 changed files with 172 additions and 87 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/api.rst
View File

@ -35,7 +35,6 @@ Contents:
date date
relationship relationship
simple simple
utils
Usefull snippets Usefull snippets
=================== ===================

2
docs/coregui/gui.rst
View File

@ -95,7 +95,7 @@ DB Manager
***************************** *****************************
Filter Editor Filter Editor
***************************** *****************************
.. automodule:: gui.filtereditor .. automodule:: gui.editors.filtereditor
.. autoclass:: EditFilter .. autoclass:: EditFilter
:members: :members:
:undoc-members: :undoc-members:

126
docs/date.rst
View File

@ -4,7 +4,7 @@ The :class:`Date Handler` Classes
DateParser DateParser
==================================== ====================================
.. automodule:: DateHandler._DateParser .. automodule:: gen.datehandler._dateparser
.. autoclass:: DateParser .. autoclass:: DateParser
:members: :members:
:undoc-members: :undoc-members:
@ -12,7 +12,7 @@ DateParser
DateDisplay DateDisplay
==================================== ====================================
.. automodule:: DateHandler._DateDisplay .. automodule:: gen.datehandler._datedisplay
.. autoclass:: DateDisplay .. autoclass:: DateDisplay
:members: :members:
:undoc-members: :undoc-members:
@ -24,14 +24,14 @@ DateDisplay
DateUtils DateUtils
==================================== ====================================
.. automodule:: DateHandler._DateUtils .. automodule:: gen.datehandler._dateutils
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
DateHandler datehandler
==================================== ====================================
.. automodule:: DateHandler._DateHandler .. automodule:: gen.datehandler._datehandler
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -40,229 +40,229 @@ Localized Date Handlers
==================================== ====================================
***************************** *****************************
DateHandler (Bulgarian) datehandler (Bulgarian)
***************************** *****************************
.. autoclass:: DateHandler._Date_bg.DateParserBG .. autoclass:: gen.datehandler._date_bg.DateParserBG
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
.. autoclass:: DateHandler._Date_bg.DateDisplayBG .. autoclass:: gen.datehandler._date_bg.DateDisplayBG
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
***************************** *****************************
DateHandler (Catalan) datehandler (Catalan)
***************************** *****************************
.. autoclass:: DateHandler._Date_ca.DateParserCA .. autoclass:: gen.datehandler._date_ca.DateParserCA
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
.. autoclass:: DateHandler._Date_ca.DateDisplayCA .. autoclass:: gen.datehandler._date_ca.DateDisplayCA
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
***************************** *****************************
DateHandler (Czech) datehandler (Czech)
***************************** *****************************
.. autoclass:: DateHandler._Date_cs.DateParserCZ .. autoclass:: gen.datehandler._date_cs.DateParserCZ
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
.. autoclass:: DateHandler._Date_cs.DateDisplayCZ .. autoclass:: gen.datehandler._date_cs.DateDisplayCZ
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
***************************** *****************************
DateHandler (German) datehandler (German)
***************************** *****************************
.. autoclass:: DateHandler._Date_de.DateParserDE .. autoclass:: gen.datehandler._date_de.DateParserDE
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
.. autoclass:: DateHandler._Date_de.DateDisplayDE .. autoclass:: gen.datehandler._date_de.DateDisplayDE
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
***************************** *****************************
DateHandler (Spanish) datehandler (Spanish)
***************************** *****************************
.. autoclass:: DateHandler._Date_es.DateParserES .. autoclass:: gen.datehandler._date_es.DateParserES
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
.. autoclass:: DateHandler._Date_es.DateDisplayES .. autoclass:: gen.datehandler._date_es.DateDisplayES
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
***************************** *****************************
DateHandler (Finnish) datehandler (Finnish)
***************************** *****************************
.. autoclass:: DateHandler._Date_fi.DateParserFI .. autoclass:: gen.datehandler._date_fi.DateParserFI
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
.. autoclass:: DateHandler._Date_fi.DateDisplayFI .. autoclass:: gen.datehandler._date_fi.DateDisplayFI
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
***************************** *****************************
DateHandler (French) datehandler (French)
***************************** *****************************
.. autoclass:: DateHandler._Date_fr.DateParserFR .. autoclass:: gen.datehandler._date_fr.DateParserFR
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
.. autoclass:: DateHandler._Date_fr.DateDisplayFR .. autoclass:: gen.datehandler._date_fr.DateDisplayFR
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
***************************** *****************************
DateHandler (Croatian) datehandler (Croatian)
***************************** *****************************
.. autoclass:: DateHandler._Date_hr.DateParserHR .. autoclass:: gen.datehandler._date_hr.DateParserHR
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
.. autoclass:: DateHandler._Date_hr.DateDisplayHR .. autoclass:: gen.datehandler._date_hr.DateDisplayHR
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
***************************** *****************************
DateHandler (Italian) datehandler (Italian)
***************************** *****************************
.. autoclass:: DateHandler._Date_it.DateParserIT .. autoclass:: gen.datehandler._date_it.DateParserIT
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
.. autoclass:: DateHandler._Date_it.DateDisplayIT .. autoclass:: gen.datehandler._date_it.DateDisplayIT
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
***************************** *****************************
DateHandler (Lituanian) datehandler (Lituanian)
***************************** *****************************
.. autoclass:: DateHandler._Date_lt.DateParserLT .. autoclass:: gen.datehandler._date_lt.DateParserLT
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
.. autoclass:: DateHandler._Date_lt.DateDisplayLT .. autoclass:: gen.datehandler._date_lt.DateDisplayLT
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
***************************** *****************************
DateHandler (Norwegian) datehandler (Norwegian)
***************************** *****************************
.. autoclass:: DateHandler._Date_nb.DateParserNb .. autoclass:: gen.datehandler._date_nb.DateParserNb
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
.. autoclass:: DateHandler._Date_nb.DateDisplayNb .. autoclass:: gen.datehandler._date_nb.DateDisplayNb
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
***************************** *****************************
DateHandler (Dutch) datehandler (Dutch)
***************************** *****************************
.. autoclass:: DateHandler._Date_nl.DateParserNL .. autoclass:: gen.datehandler._date_nl.DateParserNL
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
.. autoclass:: DateHandler._Date_nl.DateDisplayNL .. autoclass:: gen.datehandler._date_nl.DateDisplayNL
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
***************************** *****************************
DateHandler (Polish) datehandler (Polish)
***************************** *****************************
.. autoclass:: DateHandler._Date_pl.DateParserPL .. autoclass:: gen.datehandler._date_pl.DateParserPL
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
.. autoclass:: DateHandler._Date_pl.DateDisplayPL .. autoclass:: gen.datehandler._date_pl.DateDisplayPL
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
***************************** *****************************
DateHandler (Portuguese) datehandler (Portuguese)
***************************** *****************************
.. autoclass:: DateHandler._Date_pt.DateParserPT .. autoclass:: gen.datehandler._date_pt.DateParserPT
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
.. autoclass:: DateHandler._Date_pt.DateDisplayPT .. autoclass:: gen.datehandler._date_pt.DateDisplayPT
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
***************************** *****************************
DateHandler (Russian) datehandler (Russian)
***************************** *****************************
.. autoclass:: DateHandler._Date_ru.DateParserRU .. autoclass:: gen.datehandler._date_ru.DateParserRU
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
.. autoclass:: DateHandler._Date_ru.DateDisplayRU .. autoclass:: gen.datehandler._date_ru.DateDisplayRU
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
***************************** *****************************
DateHandler (Slovak) datehandler (Slovak)
***************************** *****************************
.. autoclass:: DateHandler._Date_sk.DateParserSK .. autoclass:: gen.datehandler._date_sk.DateParserSK
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
.. autoclass:: DateHandler._Date_sk.DateDisplaySK .. autoclass:: gen.datehandler._date_sk.DateDisplaySK
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
***************************** *****************************
DateHandler (Slovenian) datehandler (Slovenian)
***************************** *****************************
.. autoclass:: DateHandler._Date_sl.DateParserSL .. autoclass:: gen.datehandler._date_sl.DateParserSL
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
.. autoclass:: DateHandler._Date_sl.DateDisplaySL .. autoclass:: gen.datehandler._date_sl.DateDisplaySL
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
***************************** *****************************
DateHandler (Serbian) datehandler (Serbian)
***************************** *****************************
.. autoclass:: DateHandler._Date_sr.DateParserSR .. autoclass:: gen.datehandler._date_sr.DateParserSR
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
.. autoclass:: DateHandler._Date_sr.DateDisplaySR_latin .. autoclass:: gen.datehandler._date_sr.DateDisplaySR_latin
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
***************************** *****************************
DateHandler (Swedish) datehandler (Swedish)
***************************** *****************************
.. autoclass:: DateHandler._Date_sv.DateParserSv .. autoclass:: gen.datehandler._date_sv.DateParserSv
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
.. autoclass:: DateHandler._Date_sv.DateDisplaySv .. autoclass:: gen.datehandler._date_sv.DateDisplaySv
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
@ -273,7 +273,7 @@ The :class:`Date Edition` Classes
DateEdit DateEdit
==================================== ====================================
.. automodule:: DateEdit .. automodule:: gui.editors.editdate
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:

54
docs/gen/gen.rst
View File

@ -4,6 +4,60 @@ The :mod:`gen` Module
.. automodule:: gen .. automodule:: gen
*****************************
Database State
*****************************
.. automodule:: gen.dbstate
.. autoclass:: DbState
:members:
:undoc-members:
:show-inheritance:
*****************************
Errors
*****************************
.. automodule:: gen.errors
.. autoclass:: DatabaseError
:members:
:undoc-members:
:show-inheritance:
.. autoclass:: DateError
:members:
:undoc-members:
:show-inheritance:
.. autoclass:: DbError
:members:
:undoc-members:
:show-inheritance:
TODO
*****************************
Recent Files
*****************************
.. automodule:: gen.recentfiles
.. autoclass:: RecentFiles
:members:
:undoc-members:
:show-inheritance:
.. autoclass:: RecentItem
:members:
:undoc-members:
:show-inheritance:
.. autoclass:: RecentParser
:members:
:undoc-members:
:show-inheritance:
*****************************
Sort
*****************************
.. automodule:: gen.sort
.. autoclass:: Sort
:members:
:undoc-members:
:show-inheritance:
***************************** *****************************
Update callback Update callback
***************************** *****************************

4
docs/gen/gen_proxy.rst
View File

@ -34,10 +34,6 @@ Private
References References
==================================== ====================================
.. automodule:: gen.proxy.referenced
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.proxy.referencedbyselection .. automodule:: gen.proxy.referencedbyselection
:members: :members:
:undoc-members: :undoc-members:

50
docs/gen/gen_utils.rst
View File

@ -14,11 +14,59 @@ Utils
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
.. automodule:: gen.utils.cast
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.utils.config
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.utils.configmanager .. automodule:: gen.utils.configmanager
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
.. automodule:: gen.utils.fallback .. automodule:: gen.utils.db
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.utils.file
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.utils.id
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.utils.image
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.utils.keyword
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.utils.lds
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.utils.mactrans
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.utils.place
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.utils.string
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.utils.trans
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.utils.unknown
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:

2
docs/relationship.rst
View File

@ -2,7 +2,7 @@
The :class:`RelationshipCalculator` Class The :class:`RelationshipCalculator` Class
######################################### #########################################
.. automodule:: Relationship .. automodule:: gen.relationship
.. autoclass:: RelationshipCalculator .. autoclass:: RelationshipCalculator
:members: :members:
:undoc-members: :undoc-members:

8
docs/simple.rst
View File

@ -2,25 +2,25 @@
The :class:`Simple` Classes The :class:`Simple` Classes
########################### ###########################
.. automodule:: Simple .. automodule:: gen.simple
Simple Access Simple Access
==================================== ====================================
.. automodule:: Simple._SimpleAccess .. automodule:: gen.simple._simpleaccess
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
Simple Doc Simple Doc
==================================== ====================================
.. automodule:: Simple._SimpleDoc .. automodule:: gen.simple._simpledoc
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
Simple Table Simple Table
==================================== ====================================
.. automodule:: Simple._SimpleTable .. automodule:: gen.simple._simpletable
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:

12
docs/utils.rst
View File

@ -1,12 +0,0 @@
############################
The :mod:`Utils` Module
############################
Contents:
.. automodule:: Utils
:members:
:undoc-members:
:show-inheritance: