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

6028: Fix imports for documentation generation

Browse Source 
svn: r23049
This commit is contained in:
Nick Hall
2013-09-06 23:09:43 +00:00
parent 859b030238
commit 4385cdc382
13 changed files with 248 additions and 253 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/conf.py
View File

@@ -18,13 +18,8 @@ import sys, os
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.append(os.path.abspath('.'))
#documentation in root/docs, allow import from root/src where GRAMPS modules life
sourcedir = (os.path.abspath('.')).split(os.sep)[:-1] + ['gramps']
sys.path.append((os.sep).join(sourcedir))
#make it possible to add plugins --> walk the plugin dir and add to sys.path.append
for (dirpath, dirnames, filenames) in os.walk((os.sep).join(sourcedir + ['plugins'])):
# add the directory to the python search path
sys.path.append(dirpath)
#documentation in root/docs, allow import from root
sys.path.append(os.path.abspath(os.pardir))
# -- General configuration -----------------------------------------------------

8
docs/coregui/gui.rst
View File

@@ -1,6 +1,6 @@
##########################
############################
The :mod:`gramps.gui` Module
##########################
############################
.. automodule:: gramps.gui
@@ -156,12 +156,12 @@ Filter Editor
*****************************
Gramps Bar
*****************************
.. automodule:: gramps.gui.grampsbar
.. automodule:: gramps.gui.widgets.grampletbar
.. autoclass:: DetachedWindow
:members:
:undoc-members:
:show-inheritance:
.. autoclass:: GrampsBar
.. autoclass:: GrampletBar
:members:
:undoc-members:
:show-inheritance:

84
docs/date.rst
View File

@@ -4,7 +4,7 @@ The :class:`Date Handler` Classes
DateParser
====================================
.. automodule:: gen.datehandler._dateparser
.. automodule:: gramps.gen.datehandler._dateparser
.. autoclass:: DateParser
:members:
:undoc-members:
@@ -12,7 +12,7 @@ DateParser
DateDisplay
====================================
.. automodule:: gen.datehandler._datedisplay
.. automodule:: gramps.gen.datehandler._datedisplay
.. autoclass:: DateDisplay
:members:
:undoc-members:
@@ -24,14 +24,14 @@ DateDisplay
DateUtils
====================================
.. automodule:: gen.datehandler._dateutils
.. automodule:: gramps.gen.datehandler._dateutils
:members:
:undoc-members:
:show-inheritance:
DateHandler
====================================
.. automodule:: gen.datehandler._datehandler
.. automodule:: gramps.gen.datehandler._datehandler
:members:
:undoc-members:
:show-inheritance:
@@ -42,11 +42,11 @@ Localized Date Handlers
*****************************
DateHandler (Bulgarian)
*****************************
.. autoclass:: gen.datehandler._date_bg.DateParserBG
.. autoclass:: gramps.gen.datehandler._date_bg.DateParserBG
:members:
:undoc-members:
:show-inheritance:
.. autoclass:: gen.datehandler._date_bg.DateDisplayBG
.. autoclass:: gramps.gen.datehandler._date_bg.DateDisplayBG
:members:
:undoc-members:
:show-inheritance:
@@ -54,11 +54,11 @@ DateHandler (Bulgarian)
*****************************
DateHandler (Catalan)
*****************************
.. autoclass:: gen.datehandler._date_ca.DateParserCA
.. autoclass:: gramps.gen.datehandler._date_ca.DateParserCA
:members:
:undoc-members:
:show-inheritance:
.. autoclass:: gen.datehandler._date_ca.DateDisplayCA
.. autoclass:: gramps.gen.datehandler._date_ca.DateDisplayCA
:members:
:undoc-members:
:show-inheritance:
@@ -66,11 +66,11 @@ DateHandler (Catalan)
*****************************
DateHandler (Czech)
*****************************
.. autoclass:: gen.datehandler._date_cs.DateParserCZ
.. autoclass:: gramps.gen.datehandler._date_cs.DateParserCZ
:members:
:undoc-members:
:show-inheritance:
.. autoclass:: gen.datehandler._date_cs.DateDisplayCZ
.. autoclass:: gramps.gen.datehandler._date_cs.DateDisplayCZ
:members:
:undoc-members:
:show-inheritance:
@@ -78,11 +78,11 @@ DateHandler (Czech)
*****************************
DateHandler (German)
*****************************
.. autoclass:: gen.datehandler._date_de.DateParserDE
.. autoclass:: gramps.gen.datehandler._date_de.DateParserDE
:members:
:undoc-members:
:show-inheritance:
.. autoclass:: gen.datehandler._date_de.DateDisplayDE
.. autoclass:: gramps.gen.datehandler._date_de.DateDisplayDE
:members:
:undoc-members:
:show-inheritance:
@@ -90,11 +90,11 @@ DateHandler (German)
*****************************
DateHandler (Spanish)
*****************************
.. autoclass:: gen.datehandler._date_es.DateParserES
.. autoclass:: gramps.gen.datehandler._date_es.DateParserES
:members:
:undoc-members:
:show-inheritance:
.. autoclass:: gen.datehandler._date_es.DateDisplayES
.. autoclass:: gramps.gen.datehandler._date_es.DateDisplayES
:members:
:undoc-members:
:show-inheritance:
@@ -102,11 +102,11 @@ DateHandler (Spanish)
*****************************
DateHandler (Finnish)
*****************************
.. autoclass:: gen.datehandler._date_fi.DateParserFI
.. autoclass:: gramps.gen.datehandler._date_fi.DateParserFI
:members:
:undoc-members:
:show-inheritance:
.. autoclass:: gen.datehandler._date_fi.DateDisplayFI
.. autoclass:: gramps.gen.datehandler._date_fi.DateDisplayFI
:members:
:undoc-members:
:show-inheritance:
@@ -114,11 +114,11 @@ DateHandler (Finnish)
*****************************
DateHandler (French)
*****************************
.. autoclass:: gen.datehandler._date_fr.DateParserFR
.. autoclass:: gramps.gen.datehandler._date_fr.DateParserFR
:members:
:undoc-members:
:show-inheritance:
.. autoclass:: gen.datehandler._date_fr.DateDisplayFR
.. autoclass:: gramps.gen.datehandler._date_fr.DateDisplayFR
:members:
:undoc-members:
:show-inheritance:
@@ -126,11 +126,11 @@ DateHandler (French)
*****************************
DateHandler (Croatian)
*****************************
.. autoclass:: gen.datehandler._date_hr.DateParserHR
.. autoclass:: gramps.gen.datehandler._date_hr.DateParserHR
:members:
:undoc-members:
:show-inheritance:
.. autoclass:: gen.datehandler._date_hr.DateDisplayHR
.. autoclass:: gramps.gen.datehandler._date_hr.DateDisplayHR
:members:
:undoc-members:
:show-inheritance:
@@ -138,11 +138,11 @@ DateHandler (Croatian)
*****************************
DateHandler (Italian)
*****************************
.. autoclass:: gen.datehandler._date_it.DateParserIT
.. autoclass:: gramps.gen.datehandler._date_it.DateParserIT
:members:
:undoc-members:
:show-inheritance:
.. autoclass:: gen.datehandler._date_it.DateDisplayIT
.. autoclass:: gramps.gen.datehandler._date_it.DateDisplayIT
:members:
:undoc-members:
:show-inheritance:
@@ -150,11 +150,11 @@ DateHandler (Italian)
*****************************
DateHandler (Lituanian)
*****************************
.. autoclass:: gen.datehandler._date_lt.DateParserLT
.. autoclass:: gramps.gen.datehandler._date_lt.DateParserLT
:members:
:undoc-members:
:show-inheritance:
.. autoclass:: gen.datehandler._date_lt.DateDisplayLT
.. autoclass:: gramps.gen.datehandler._date_lt.DateDisplayLT
:members:
:undoc-members:
:show-inheritance:
@@ -162,11 +162,11 @@ DateHandler (Lituanian)
*****************************
DateHandler (Norwegian)
*****************************
.. autoclass:: gen.datehandler._date_nb.DateParserNb
.. autoclass:: gramps.gen.datehandler._date_nb.DateParserNb
:members:
:undoc-members:
:show-inheritance:
.. autoclass:: gen.datehandler._date_nb.DateDisplayNb
.. autoclass:: gramps.gen.datehandler._date_nb.DateDisplayNb
:members:
:undoc-members:
:show-inheritance:
@@ -174,11 +174,11 @@ DateHandler (Norwegian)
*****************************
DateHandler (Dutch)
*****************************
.. autoclass:: gen.datehandler._date_nl.DateParserNL
.. autoclass:: gramps.gen.datehandler._date_nl.DateParserNL
:members:
:undoc-members:
:show-inheritance:
.. autoclass:: gen.datehandler._date_nl.DateDisplayNL
.. autoclass:: gramps.gen.datehandler._date_nl.DateDisplayNL
:members:
:undoc-members:
:show-inheritance:
@@ -186,11 +186,11 @@ DateHandler (Dutch)
*****************************
DateHandler (Polish)
*****************************
.. autoclass:: gen.datehandler._date_pl.DateParserPL
.. autoclass:: gramps.gen.datehandler._date_pl.DateParserPL
:members:
:undoc-members:
:show-inheritance:
.. autoclass:: gen.datehandler._date_pl.DateDisplayPL
.. autoclass:: gramps.gen.datehandler._date_pl.DateDisplayPL
:members:
:undoc-members:
:show-inheritance:
@@ -198,11 +198,11 @@ DateHandler (Polish)
*****************************
DateHandler (Portuguese)
*****************************
.. autoclass:: gen.datehandler._date_pt.DateParserPT
.. autoclass:: gramps.gen.datehandler._date_pt.DateParserPT
:members:
:undoc-members:
:show-inheritance:
.. autoclass:: gen.datehandler._date_pt.DateDisplayPT
.. autoclass:: gramps.gen.datehandler._date_pt.DateDisplayPT
:members:
:undoc-members:
:show-inheritance:
@@ -210,11 +210,11 @@ DateHandler (Portuguese)
*****************************
DateHandler (Russian)
*****************************
.. autoclass:: gen.datehandler._date_ru.DateParserRU
.. autoclass:: gramps.gen.datehandler._date_ru.DateParserRU
:members:
:undoc-members:
:show-inheritance:
.. autoclass:: gen.datehandler._date_ru.DateDisplayRU
.. autoclass:: gramps.gen.datehandler._date_ru.DateDisplayRU
:members:
:undoc-members:
:show-inheritance:
@@ -222,11 +222,11 @@ DateHandler (Russian)
*****************************
DateHandler (Slovak)
*****************************
.. autoclass:: gen.datehandler._date_sk.DateParserSK
.. autoclass:: gramps.gen.datehandler._date_sk.DateParserSK
:members:
:undoc-members:
:show-inheritance:
.. autoclass:: gen.datehandler._date_sk.DateDisplaySK
.. autoclass:: gramps.gen.datehandler._date_sk.DateDisplaySK
:members:
:undoc-members:
:show-inheritance:
@@ -234,11 +234,11 @@ DateHandler (Slovak)
*****************************
DateHandler (Slovenian)
*****************************
.. autoclass:: gen.datehandler._date_sl.DateParserSL
.. autoclass:: gramps.gen.datehandler._date_sl.DateParserSL
:members:
:undoc-members:
:show-inheritance:
.. autoclass:: gen.datehandler._date_sl.DateDisplaySL
.. autoclass:: gramps.gen.datehandler._date_sl.DateDisplaySL
:members:
:undoc-members:
:show-inheritance:
@@ -246,11 +246,11 @@ DateHandler (Slovenian)
*****************************
DateHandler (Serbian)
*****************************
.. autoclass:: gen.datehandler._date_sr.DateParserSR
.. autoclass:: gramps.gen.datehandler._date_sr.DateParserSR
:members:
:undoc-members:
:show-inheritance:
.. autoclass:: gen.datehandler._date_sr.DateDisplaySR_latin
.. autoclass:: gramps.gen.datehandler._date_sr.DateDisplaySR_latin
:members:
:undoc-members:
:show-inheritance:
@@ -258,11 +258,11 @@ DateHandler (Serbian)
*****************************
DateHandler (Swedish)
*****************************
.. autoclass:: gen.datehandler._date_sv.DateParserSv
.. autoclass:: gramps.gen.datehandler._date_sv.DateParserSv
:members:
:undoc-members:
:show-inheritance:
.. autoclass:: gen.datehandler._date_sv.DateDisplaySv
.. autoclass:: gramps.gen.datehandler._date_sv.DateDisplaySv
:members:
:undoc-members:
:show-inheritance:

20
docs/gen/gen.rst
View File

@@ -1,13 +1,13 @@
##########################
The :mod:`gen` Module
##########################
############################
The :mod:`gramps.gen` Module
############################
.. automodule:: gen
.. automodule:: gramps.gen
*****************************
Database State
*****************************
.. automodule:: gen.dbstate
.. automodule:: gramps.gen.dbstate
.. autoclass:: DbState
:members:
:undoc-members:
@@ -16,7 +16,7 @@ Database State
*****************************
Errors
*****************************
.. automodule:: gen.errors
.. automodule:: gramps.gen.errors
.. autoclass:: DatabaseError
:members:
:undoc-members:
@@ -35,7 +35,7 @@ TODO
*****************************
Recent Files
*****************************
.. automodule:: gen.recentfiles
.. automodule:: gramps.gen.recentfiles
.. autoclass:: RecentFiles
:members:
:undoc-members:
@@ -52,7 +52,7 @@ Recent Files
*****************************
Sort
*****************************
.. automodule:: gen.sort
.. automodule:: gramps.gen.sort
.. autoclass:: Sort
:members:
:undoc-members:
@@ -61,7 +61,7 @@ Sort
*****************************
Update callback
*****************************
.. automodule:: gen.updatecallback
.. automodule:: gramps.gen.updatecallback
.. autoclass:: UpdateCallback
:members:
:undoc-members:
@@ -70,7 +70,7 @@ Update callback
*****************************
User
*****************************
.. automodule:: gen.user
.. automodule:: gramps.gen.user
.. autoclass:: User
:members:
:undoc-members:

30
docs/gen/gen_db.rst
View File

@@ -1,78 +1,78 @@
##########################
The :mod:`gen.db` Module
##########################
###############################
The :mod:`gramps.gen.db` Module
###############################
.. automodule:: gen.db
.. automodule:: gramps.gen.db
GrampsDbBase
====================================
.. automodule:: gen.db.base
.. automodule:: gramps.gen.db.base
:members:
:undoc-members:
:show-inheritance:
GrampsDbRead
====================================
.. automodule:: gen.db.read
.. automodule:: gramps.gen.db.read
:members:
:show-inheritance:
GrampsDbWrite
====================================
.. automodule:: gen.db.write
.. automodule:: gramps.gen.db.write
:members:
:undoc-members:
:show-inheritance:
GrampsCursor
====================================
.. automodule:: gen.db.cursor
.. automodule:: gramps.gen.db.cursor
:members:
:undoc-members:
:show-inheritance:
BSDDBtxn
====================================
.. automodule:: gen.db.bsddbtxn
.. automodule:: gramps.gen.db.bsddbtxn
:members:
:undoc-members:
:show-inheritance:
GrampsDbTxn
====================================
.. automodule:: gen.db.txn
.. automodule:: gramps.gen.db.txn
:members:
:undoc-members:
:show-inheritance:
GrampsDbUndo
====================================
.. automodule:: gen.db.undoredo
.. automodule:: gramps.gen.db.undoredo
:members:
:undoc-members:
:show-inheritance:
DbConst
====================================
.. automodule:: gen.db.dbconst
.. automodule:: gramps.gen.db.dbconst
:members:
GrampsDbException
====================================
.. automodule:: gen.db.exceptions
.. automodule:: gramps.gen.db.exceptions
:members:
:undoc-members:
:show-inheritance:
Upgrade utilities
====================================
.. automodule:: gen.db.upgrade
.. automodule:: gramps.gen.db.upgrade
:members:
:undoc-members:
Backup
====================================
.. automodule:: gen.db.backup
.. automodule:: gramps.gen.db.backup
:members:
:undoc-members:
:show-inheritance:

10
docs/gen/gen_display.rst
View File

@@ -1,12 +1,12 @@
#############################
The :mod:`gen.display` Module
#############################
####################################
The :mod:`gramps.gen.display` Module
####################################
.. automodule:: gen.display
.. automodule:: gramps.gen.display
Name
====================================
.. automodule:: gen.display.name
.. automodule:: gramps.gen.display.name
:members:
:undoc-members:
:show-inheritance:

128
docs/gen/gen_lib.rst
View File

@@ -1,8 +1,8 @@
##########################
The :mod:`gen.lib` Module
##########################
################################
The :mod:`gramps.gen.lib` Module
################################
.. automodule:: gen.lib
.. automodule:: gramps.gen.lib
*****************************
Base objects
@@ -10,15 +10,15 @@ Base objects
BaseObject
====================================
.. automodule:: gen.lib.baseobj
.. autoclass:: gen.lib.baseobj.BaseObject
.. automodule:: gramps.gen.lib.baseobj
.. autoclass:: gramps.gen.lib.baseobj.BaseObject
:members:
:undoc-members:
:show-inheritance:
AddressBase
====================================
.. automodule:: gen.lib.addressbase
.. automodule:: gramps.gen.lib.addressbase
.. autoclass:: AddressBase
:members:
:undoc-members:
@@ -26,7 +26,7 @@ AddressBase
AttributeBase
====================================
.. automodule:: gen.lib.attrbase
.. automodule:: gramps.gen.lib.attrbase
.. autoclass:: AttributeBase
:members:
:undoc-members:
@@ -34,7 +34,7 @@ AttributeBase
CitationBase
====================================
.. automodule:: gen.lib.citationbase
.. automodule:: gramps.gen.lib.citationbase
.. autoclass:: CitationBase
:members:
:undoc-members:
@@ -42,7 +42,7 @@ CitationBase
DateBase
====================================
.. automodule:: gen.lib.datebase
.. automodule:: gramps.gen.lib.datebase
.. autoclass:: DateBase
:members:
:undoc-members:
@@ -50,7 +50,7 @@ DateBase
LdsOrdBase
====================================
.. automodule:: gen.lib.ldsordbase
.. automodule:: gramps.gen.lib.ldsordbase
.. autoclass:: LdsOrdBase
:members:
:undoc-members:
@@ -58,7 +58,7 @@ LdsOrdBase
LocationBase
====================================
.. automodule:: gen.lib.locationbase
.. automodule:: gramps.gen.lib.locationbase
.. autoclass:: LocationBase
:members:
:undoc-members:
@@ -66,7 +66,7 @@ LocationBase
MediaBase
====================================
.. automodule:: gen.lib.mediabase
.. automodule:: gramps.gen.lib.mediabase
.. autoclass:: MediaBase
:members:
:undoc-members:
@@ -74,7 +74,7 @@ MediaBase
NoteBase
====================================
.. automodule:: gen.lib.notebase
.. automodule:: gramps.gen.lib.notebase
.. autoclass:: NoteBase
:members:
:undoc-members:
@@ -82,7 +82,7 @@ NoteBase
PlaceBase
====================================
.. automodule:: gen.lib.placebase
.. automodule:: gramps.gen.lib.placebase
.. autoclass:: PlaceBase
:members:
:undoc-members:
@@ -90,7 +90,7 @@ PlaceBase
PrivacyBase
====================================
.. automodule:: gen.lib.privacybase
.. automodule:: gramps.gen.lib.privacybase
.. autoclass:: PrivacyBase
:members:
:undoc-members:
@@ -98,7 +98,7 @@ PrivacyBase
RefBase
====================================
.. automodule:: gen.lib.refbase
.. automodule:: gramps.gen.lib.refbase
.. autoclass:: RefBase
:members:
:undoc-members:
@@ -106,7 +106,7 @@ RefBase
SurnameBase
====================================
.. automodule:: gen.lib.surnamebase
.. automodule:: gramps.gen.lib.surnamebase
.. autoclass:: SurnameBase
:members:
:undoc-members:
@@ -114,7 +114,7 @@ SurnameBase
TagBase
====================================
.. automodule:: gen.lib.tagbase
.. automodule:: gramps.gen.lib.tagbase
.. autoclass:: TagBase
:members:
:undoc-members:
@@ -122,7 +122,7 @@ TagBase
UrlBase
====================================
.. automodule:: gen.lib.urlbase
.. automodule:: gramps.gen.lib.urlbase
.. autoclass:: UrlBase
:members:
:undoc-members:
@@ -134,7 +134,7 @@ Primary objects
BasicPrimaryObject
====================================
.. automodule:: gen.lib.primaryobj
.. automodule:: gramps.gen.lib.primaryobj
.. autoclass:: BasicPrimaryObject
:members:
:undoc-members:
@@ -149,7 +149,7 @@ PrimaryObject
Person
====================================
.. automodule:: gen.lib.person
.. automodule:: gramps.gen.lib.person
.. autoclass:: Person
:members:
:undoc-members:
@@ -157,7 +157,7 @@ Person
Family
====================================
.. automodule:: gen.lib.family
.. automodule:: gramps.gen.lib.family
.. autoclass:: Family
:members:
:undoc-members:
@@ -165,7 +165,7 @@ Family
Event
====================================
.. automodule:: gen.lib.event
.. automodule:: gramps.gen.lib.event
.. autoclass:: Event
:members:
:undoc-members:
@@ -173,7 +173,7 @@ Event
Place
====================================
.. automodule:: gen.lib.place
.. automodule:: gramps.gen.lib.place
.. autoclass:: Place
:members:
:undoc-members:
@@ -181,7 +181,7 @@ Place
Source
====================================
.. automodule:: gen.lib.src
.. automodule:: gramps.gen.lib.src
.. autoclass:: Source
:members:
:undoc-members:
@@ -189,7 +189,7 @@ Source
Citation
====================================
.. automodule:: gen.lib.citation
.. automodule:: gramps.gen.lib.citation
.. autoclass:: Citation
:members:
:undoc-members:
@@ -197,7 +197,7 @@ Citation
Media Object
====================================
.. automodule:: gen.lib.mediaobj
.. automodule:: gramps.gen.lib.mediaobj
.. autoclass:: MediaObject
:members:
:undoc-members:
@@ -205,7 +205,7 @@ Media Object
Repository
====================================
.. automodule:: gen.lib.repo
.. automodule:: gramps.gen.lib.repo
.. autoclass:: Repository
:members:
:undoc-members:
@@ -213,7 +213,7 @@ Repository
Note
====================================
.. automodule:: gen.lib.note
.. automodule:: gramps.gen.lib.note
.. autoclass:: Note
:members:
:undoc-members:
@@ -225,7 +225,7 @@ Secondary objects
Secondary Object
====================================
.. automodule:: gen.lib.secondaryobj
.. automodule:: gramps.gen.lib.secondaryobj
.. autoclass:: SecondaryObject
:members:
:undoc-members:
@@ -233,7 +233,7 @@ Secondary Object
Address
====================================
.. automodule:: gen.lib.address
.. automodule:: gramps.gen.lib.address
.. autoclass:: Address
:members:
:undoc-members:
@@ -241,7 +241,7 @@ Address
Attribute
====================================
.. automodule:: gen.lib.attribute
.. automodule:: gramps.gen.lib.attribute
.. autoclass:: Attribute
:members:
:undoc-members:
@@ -249,7 +249,7 @@ Attribute
LdsOrd
====================================
.. automodule:: gen.lib.ldsord
.. automodule:: gramps.gen.lib.ldsord
.. autoclass:: LdsOrd
:members:
:undoc-members:
@@ -257,7 +257,7 @@ LdsOrd
Location
====================================
.. automodule:: gen.lib.location
.. automodule:: gramps.gen.lib.location
.. autoclass:: Location
:members:
:undoc-members:
@@ -265,7 +265,7 @@ Location
Name
====================================
.. automodule:: gen.lib.name
.. automodule:: gramps.gen.lib.name
.. autoclass:: Name
:members:
:undoc-members:
@@ -273,7 +273,7 @@ Name
Surname
====================================
.. automodule:: gen.lib.surname
.. automodule:: gramps.gen.lib.surname
.. autoclass:: Surname
:members:
:undoc-members:
@@ -281,7 +281,7 @@ Surname
Url
====================================
.. automodule:: gen.lib.url
.. automodule:: gramps.gen.lib.url
.. autoclass:: Url
:members:
:undoc-members:
@@ -293,7 +293,7 @@ Reference objects
ChildRef
====================================
.. automodule:: gen.lib.childref
.. automodule:: gramps.gen.lib.childref
.. autoclass:: ChildRef
:members:
:undoc-members:
@@ -301,7 +301,7 @@ ChildRef
EventRef
====================================
.. automodule:: gen.lib.eventref
.. automodule:: gramps.gen.lib.eventref
.. autoclass:: EventRef
:members:
:undoc-members:
@@ -309,7 +309,7 @@ EventRef
MediaRef
====================================
.. automodule:: gen.lib.mediaref
.. automodule:: gramps.gen.lib.mediaref
.. autoclass:: MediaRef
:members:
:undoc-members:
@@ -317,7 +317,7 @@ MediaRef
PersonRef
====================================
.. automodule:: gen.lib.personref
.. automodule:: gramps.gen.lib.personref
.. autoclass:: PersonRef
:members:
:undoc-members:
@@ -325,7 +325,7 @@ PersonRef
RepoRef
====================================
.. automodule:: gen.lib.reporef
.. automodule:: gramps.gen.lib.reporef
.. autoclass:: RepoRef
:members:
:undoc-members:
@@ -337,7 +337,7 @@ Table object
Table object
====================================
.. automodule:: gen.lib.tableobj
.. automodule:: gramps.gen.lib.tableobj
:members:
:undoc-members:
:show-inheritance:
@@ -345,7 +345,7 @@ Table object
*****************************
Date objects
*****************************
.. automodule:: gen.lib.date
.. automodule:: gramps.gen.lib.date
Date
====================================
@@ -371,7 +371,7 @@ Text objects
StyledTextTag
===================
.. automodule:: gen.lib.styledtexttag
.. automodule:: gramps.gen.lib.styledtexttag
.. autoclass:: StyledTextTag
:members:
:undoc-members:
@@ -379,7 +379,7 @@ StyledTextTag
StyledText
===========
.. automodule:: gen.lib.styledtext
.. automodule:: gramps.gen.lib.styledtext
.. autoclass:: StyledText
:members:
:undoc-members:
@@ -392,7 +392,7 @@ Meta data
GenderStats
============
.. automodule:: gen.lib.genderstats
.. automodule:: gramps.gen.lib.genderstats
.. autoclass:: GenderStats
:members:
:undoc-members:
@@ -400,7 +400,7 @@ GenderStats
Researcher
===========
.. automodule:: gen.lib.researcher
.. automodule:: gramps.gen.lib.researcher
.. autoclass:: Researcher
:members:
:undoc-members:
@@ -409,7 +409,7 @@ Researcher
*****************************
Type classes
*****************************
.. automodule:: gen.lib.grampstype
.. automodule:: gramps.gen.lib.grampstype
.. autoclass:: GrampsTypeMeta
:members:
:undoc-members:
@@ -424,21 +424,21 @@ GrampsType
AttributeType
=============
.. automodule:: gen.lib.attrtype
.. automodule:: gramps.gen.lib.attrtype
:members:
:undoc-members:
:show-inheritance:
ChildRefType
=============
.. automodule:: gen.lib.childreftype
.. automodule:: gramps.gen.lib.childreftype
:members:
:undoc-members:
:show-inheritance:
EventType
===========
.. automodule:: gen.lib.eventtype
.. automodule:: gramps.gen.lib.eventtype
.. autoclass:: EventType
:members:
:undoc-members:
@@ -446,70 +446,70 @@ EventType
EventRoleType
==============
.. automodule:: gen.lib.eventroletype
.. automodule:: gramps.gen.lib.eventroletype
:members:
:undoc-members:
:show-inheritance:
FamilyRelType
=============
.. automodule:: gen.lib.familyreltype
.. automodule:: gramps.gen.lib.familyreltype
:members:
:undoc-members:
:show-inheritance:
MarkerType
==========
.. automodule:: gen.lib.markertype
.. automodule:: gramps.gen.lib.markertype
:members:
:undoc-members:
:show-inheritance:
NameType
===========
.. automodule:: gen.lib.nametype
.. automodule:: gramps.gen.lib.nametype
:members:
:undoc-members:
:show-inheritance:
NameOriginType
==============
.. automodule:: gen.lib.nameorigintype
.. automodule:: gramps.gen.lib.nameorigintype
:members:
:undoc-members:
:show-inheritance:
NoteType
=========
.. automodule:: gen.lib.notetype
.. automodule:: gramps.gen.lib.notetype
:members:
:undoc-members:
:show-inheritance:
RepositoryType
==============
.. automodule:: gen.lib.repotype
.. automodule:: gramps.gen.lib.repotype
:members:
:undoc-members:
:show-inheritance:
SourceMediaType
================
.. automodule:: gen.lib.srcmediatype
.. automodule:: gramps.gen.lib.srcmediatype
:members:
:undoc-members:
:show-inheritance:
StyledTextTagType
==================
.. automodule:: gen.lib.styledtexttagtype
.. automodule:: gramps.gen.lib.styledtexttagtype
:members:
:undoc-members:
:show-inheritance:
UrlType
========
.. automodule:: gen.lib.urltype
.. automodule:: gramps.gen.lib.urltype
:members:
:undoc-members:
:show-inheritance:
@@ -521,7 +521,7 @@ Privacy
PrivateSourceNote
============
.. automodule:: gen.lib.privsrcnote
.. automodule:: gramps.gen.lib.privsrcnote
.. autoclass:: PrivateSourceNote
:members:
:undoc-members:

104
docs/gen/gen_plug.rst
View File

@@ -1,119 +1,119 @@
############################
The :mod:`gen.plug` Module
############################
#################################
The :mod:`gramps.gen.plug` Module
#################################
.. automodule:: gen.plug
.. automodule:: gramps.gen.plug
Plugin
====================================
.. automodule:: gen.plug._plugin
.. automodule:: gramps.gen.plug._plugin
:members:
:undoc-members:
:show-inheritance:
BaseManager
====================================
.. automodule:: gen.plug._manager
.. automodule:: gramps.gen.plug._manager
:members:
:undoc-members:
:show-inheritance:
Export
====================================
.. automodule:: gen.plug._export
.. automodule:: gramps.gen.plug._export
:members:
:undoc-members:
:show-inheritance:
Gramplet
====================================
.. automodule:: gen.plug._gramplet
.. automodule:: gramps.gen.plug._gramplet
:members:
:undoc-members:
:show-inheritance:
Import
====================================
.. automodule:: gen.plug._import
.. automodule:: gramps.gen.plug._import
:members:
:undoc-members:
:show-inheritance:
Menu
====================================
.. automodule:: gen.plug.menu._menu
.. automodule:: gramps.gen.plug.menu._menu
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.plug.menu._boolean
.. automodule:: gramps.gen.plug.menu._boolean
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.plug.menu._booleanlist
.. automodule:: gramps.gen.plug.menu._booleanlist
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.plug.menu._color
.. automodule:: gramps.gen.plug.menu._color
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.plug.menu._destination
.. automodule:: gramps.gen.plug.menu._destination
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.plug.menu._enumeratedlist
.. automodule:: gramps.gen.plug.menu._enumeratedlist
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.plug.menu._family
.. automodule:: gramps.gen.plug.menu._family
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.plug.menu._filter
.. automodule:: gramps.gen.plug.menu._filter
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.plug.menu._media
.. automodule:: gramps.gen.plug.menu._media
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.plug.menu._note
.. automodule:: gramps.gen.plug.menu._note
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.plug.menu._number
.. automodule:: gramps.gen.plug.menu._number
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.plug.menu._option
.. automodule:: gramps.gen.plug.menu._option
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.plug.menu._person
.. automodule:: gramps.gen.plug.menu._person
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.plug.menu._personlist
.. automodule:: gramps.gen.plug.menu._personlist
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.plug.menu._placelist
.. automodule:: gramps.gen.plug.menu._placelist
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.plug.menu._string
.. automodule:: gramps.gen.plug.menu._string
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.plug.menu._style
.. automodule:: gramps.gen.plug.menu._style
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.plug.menu._surnamecolor
.. automodule:: gramps.gen.plug.menu._surnamecolor
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.plug.menu._text
.. automodule:: gramps.gen.plug.menu._text
:members:
:undoc-members:
:show-inheritance:
@@ -121,38 +121,38 @@ Menu
*****************************
Options
*****************************
.. automodule:: gen.plug._options
.. automodule:: gramps.gen.plug._options
:members:
:undoc-members:
:show-inheritance:
Reports
====================================
.. automodule:: gen.plug.report._options
.. automodule:: gramps.gen.plug.report._options
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.plug.report._bibliography
.. automodule:: gramps.gen.plug.report._bibliography
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.plug.report._constants
.. automodule:: gramps.gen.plug.report._constants
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.plug.report.endnotes
.. automodule:: gramps.gen.plug.report.endnotes
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.plug.report._paper
.. automodule:: gramps.gen.plug.report._paper
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.plug.report._reportbase
.. automodule:: gramps.gen.plug.report._reportbase
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.plug.report.utils
.. automodule:: gramps.gen.plug.report.utils
:members:
:undoc-members:
:show-inheritance:
@@ -160,7 +160,7 @@ Reports
*****************************
Docgen
*****************************
.. automodule:: gen.plug._docgenplugin
.. automodule:: gramps.gen.plug._docgenplugin
:members:
:undoc-members:
:show-inheritance:
@@ -168,47 +168,47 @@ Docgen
*****************************
Generators
*****************************
.. automodule:: gen.plug.docgen.basedoc
.. automodule:: gramps.gen.plug.docgen.basedoc
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.plug.docgen.drawdoc
.. automodule:: gramps.gen.plug.docgen.drawdoc
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.plug.docgen.fontscale
.. automodule:: gramps.gen.plug.docgen.fontscale
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.plug.docgen.fontstyle
.. automodule:: gramps.gen.plug.docgen.fontstyle
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.plug.docgen.graphdoc
.. automodule:: gramps.gen.plug.docgen.graphdoc
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.plug.docgen.graphicstyle
.. automodule:: gramps.gen.plug.docgen.graphicstyle
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.plug.docgen.paperstyle
.. automodule:: gramps.gen.plug.docgen.paperstyle
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.plug.docgen.paragraphstyle
.. automodule:: gramps.gen.plug.docgen.paragraphstyle
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.plug.docgen.stylesheet
.. automodule:: gramps.gen.plug.docgen.stylesheet
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.plug.docgen.tablestyle
.. automodule:: gramps.gen.plug.docgen.tablestyle
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.plug.docgen.textdoc
.. automodule:: gramps.gen.plug.docgen.textdoc
:members:
:undoc-members:
:show-inheritance:
@@ -216,25 +216,25 @@ Generators
*****************************
Doc Backend
*****************************
.. automodule:: gen.plug.docbackend.cairobackend
.. automodule:: gramps.gen.plug.docbackend.cairobackend
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.plug.docbackend.docbackend
.. automodule:: gramps.gen.plug.docbackend.docbackend
:members:
:undoc-members:
:show-inheritance:
Register
====================================
.. automodule:: gen.plug._pluginreg
.. automodule:: gramps.gen.plug._pluginreg
:members:
:undoc-members:
:show-inheritance:
Utils
====================================
.. automodule:: gen.plug.utils
.. automodule:: gramps.gen.plug.utils
:members:
:undoc-members:
:show-inheritance:

18
docs/gen/gen_proxy.rst
View File

@@ -1,40 +1,40 @@
############################
The :mod:`gen.proxy` Module
############################
##################################
The :mod:`gramps.gen.proxy` Module
##################################
.. automodule:: gen.proxy
.. automodule:: gramps.gen.proxy
Proxy Base
====================================
.. automodule:: gen.proxy.proxybase
.. automodule:: gramps.gen.proxy.proxybase
:members:
:undoc-members:
:show-inheritance:
Filter
====================================
.. automodule:: gen.proxy.filter
.. automodule:: gramps.gen.proxy.filter
:members:
:undoc-members:
:show-inheritance:
Living
====================================
.. automodule:: gen.proxy.living
.. automodule:: gramps.gen.proxy.living
:members:
:undoc-members:
:show-inheritance:
Private
====================================
.. automodule:: gen.proxy.private
.. automodule:: gramps.gen.proxy.private
:members:
:undoc-members:
:show-inheritance:
References
====================================
.. automodule:: gen.proxy.referencedbyselection
.. automodule:: gramps.gen.proxy.referencedbyselection
:members:
:undoc-members:
:show-inheritance:

42
docs/gen/gen_utils.rst
View File

@@ -1,76 +1,76 @@
############################
The :mod:`gen.utils` Module
############################
##################################
The :mod:`gramps.gen.utils` Module
##################################
.. automodule:: gen.utils
.. automodule:: gramps.gen.utils
Utils
====================================
.. automodule:: gen.utils.alive
.. automodule:: gramps.gen.utils.alive
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.utils.callback
.. automodule:: gramps.gen.utils.callback
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.utils.callman
.. automodule:: gramps.gen.utils.callman
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.utils.cast
.. automodule:: gramps.gen.utils.cast
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.utils.config
.. automodule:: gramps.gen.utils.config
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.utils.configmanager
.. automodule:: gramps.gen.utils.configmanager
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.utils.db
.. automodule:: gramps.gen.utils.db
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.utils.file
.. automodule:: gramps.gen.utils.file
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.utils.id
.. automodule:: gramps.gen.utils.grampslocale
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.utils.image
.. automodule:: gramps.gen.utils.id
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.utils.keyword
.. automodule:: gramps.gen.utils.image
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.utils.lds
.. automodule:: gramps.gen.utils.keyword
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.utils.mactrans
.. automodule:: gramps.gen.utils.lds
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.utils.place
.. automodule:: gramps.gen.utils.maclocale
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.utils.string
.. automodule:: gramps.gen.utils.place
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.utils.trans
.. automodule:: gramps.gen.utils.string
:members:
:undoc-members:
:show-inheritance:
.. automodule:: gen.utils.unknown
.. automodule:: gramps.gen.utils.unknown
:members:
:undoc-members:
:show-inheritance:

2
docs/html.rst
View File

@@ -4,7 +4,7 @@ The :class:`Html` Class
Contents:
.. automodule:: libhtml
.. automodule:: gramps.plugins.lib.libhtml
.. autoclass:: Html
:members:
:undoc-members:

36
docs/relationship.rst
View File

@@ -2,7 +2,7 @@
The :class:`RelationshipCalculator` Class
#########################################
.. automodule:: gen.relationship
.. automodule:: gramps.gen.relationship
.. autoclass:: RelationshipCalculator
:members:
:undoc-members:
@@ -14,119 +14,119 @@ Localized Handlers
Relationship (Czech)
====================================
.. autoclass:: rel_cs.RelationshipCalculator
.. autoclass:: gramps.plugins.rel.rel_cs.RelationshipCalculator
:members:
:undoc-members:
:show-inheritance:
Relationship (Danish)
====================================
.. autoclass:: rel_da.RelationshipCalculator
.. autoclass:: gramps.plugins.rel.rel_da.RelationshipCalculator
:members:
:undoc-members:
:show-inheritance:
Relationship (German)
====================================
.. autoclass:: rel_de.RelationshipCalculator
.. autoclass:: gramps.plugins.rel.rel_de.RelationshipCalculator
:members:
:undoc-members:
:show-inheritance:
Relationship (Spanish)
====================================
.. autoclass:: rel_es.RelationshipCalculator
.. autoclass:: gramps.plugins.rel.rel_es.RelationshipCalculator
:members:
:undoc-members:
:show-inheritance:
Relationship (Finnish)
====================================
.. autoclass:: rel_fi.RelationshipCalculator
.. autoclass:: gramps.plugins.rel.rel_fi.RelationshipCalculator
:members:
:undoc-members:
:show-inheritance:
Relationship (French)
====================================
.. autoclass:: rel_fr.RelationshipCalculator
.. autoclass:: gramps.plugins.rel.rel_fr.RelationshipCalculator
:members:
:undoc-members:
:show-inheritance:
Relationship (Croatian)
====================================
.. autoclass:: rel_hr.RelationshipCalculator
.. autoclass:: gramps.plugins.rel.rel_hr.RelationshipCalculator
:members:
:undoc-members:
:show-inheritance:
Relationship (Hungarian)
====================================
.. autoclass:: rel_hu.RelationshipCalculator
.. autoclass:: gramps.plugins.rel.rel_hu.RelationshipCalculator
:members:
:undoc-members:
:show-inheritance:
Relationship (Italian)
====================================
.. autoclass:: rel_it.RelationshipCalculator
.. autoclass:: gramps.plugins.rel.rel_it.RelationshipCalculator
:members:
:undoc-members:
:show-inheritance:
Relationship (Dutch)
====================================
.. autoclass:: rel_nl.RelationshipCalculator
.. autoclass:: gramps.plugins.rel.rel_nl.RelationshipCalculator
:members:
:undoc-members:
:show-inheritance:
Relationship (Norwegian)
====================================
.. autoclass:: rel_no.RelationshipCalculator
.. autoclass:: gramps.plugins.rel.rel_no.RelationshipCalculator
:members:
:undoc-members:
:show-inheritance:
Relationship (Polish)
====================================
.. autoclass:: rel_pl.RelationshipCalculator
.. autoclass:: gramps.plugins.rel.rel_pl.RelationshipCalculator
:members:
:undoc-members:
:show-inheritance:
Relationship (Portuguese)
====================================
.. autoclass:: rel_pt.RelationshipCalculator
.. autoclass:: gramps.plugins.rel.rel_pt.RelationshipCalculator
:members:
:undoc-members:
:show-inheritance:
Relationship (Russian)
====================================
.. autoclass:: rel_ru.RelationshipCalculator
.. autoclass:: gramps.plugins.rel.rel_ru.RelationshipCalculator
:members:
:undoc-members:
:show-inheritance:
Relationship (Slovak)
====================================
.. autoclass:: rel_sk.RelationshipCalculator
.. autoclass:: gramps.plugins.rel.rel_sk.RelationshipCalculator
:members:
:undoc-members:
:show-inheritance:
Relationship (Slovenian)
====================================
.. autoclass:: rel_sl.RelationshipCalculator
.. autoclass:: gramps.plugins.rel.rel_sl.RelationshipCalculator
:members:
:undoc-members:
:show-inheritance:
Relationship (Swedish)
====================================
.. autoclass:: rel_sv.RelationshipCalculator
.. autoclass:: gramps.plugins.rel.rel_sv.RelationshipCalculator
:members:
:undoc-members:
:show-inheritance:

8
docs/simple.rst
View File

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