diff --git a/docs/api.rst b/docs/api.rst index 2a9a28b07..ebd265c5a 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -16,6 +16,7 @@ Contents: gen/gen_lib gen/gen_db + gen/gen_display gen/gen_plug gen/gen_proxy gen/gen_utils diff --git a/docs/gen/gen_db.rst b/docs/gen/gen_db.rst index 7f3283f29..b0f8019fa 100644 --- a/docs/gen/gen_db.rst +++ b/docs/gen/gen_db.rst @@ -2,158 +2,71 @@ The :mod:`gen.db` Module ########################## -Contents: - .. automodule:: gen.db -***************************** -Base object -***************************** - GrampsDbBase ==================================== .. automodule:: gen.db.base -.. autoclass:: GrampsDbBase :members: :undoc-members: :show-inheritance: -***************************** -Read object -***************************** - GrampsDbRead ==================================== .. automodule:: gen.db.read -.. autoclass:: GrampsDbRead :members: :show-inheritance: -***************************** -Write object -***************************** - GrampsDbWrite ==================================== .. automodule:: gen.db.write -.. autoclass:: GrampsDBDir :members: :undoc-members: :show-inheritance: -***************************** -Cursor -***************************** - GrampsCursor ==================================== .. automodule:: gen.db.cursor -.. autoclass:: GrampsCursor :members: :undoc-members: :show-inheritance: -***************************** -BSDDB txn -***************************** - BSDDBtxn ==================================== .. automodule:: gen.db.bsddbtxn -.. autoclass:: BSDDBTxn :members: :undoc-members: :show-inheritance: -***************************** -Txn object -***************************** - GrampsDbTxn ==================================== .. automodule:: gen.db.txn -.. autoclass:: GrampsDbTxn :members: :undoc-members: :show-inheritance: -***************************** -Undoredo object -***************************** - GrampsDbUndo ==================================== .. automodule:: gen.db.undoredo -.. autoclass:: GrampsDbUndo :members: :undoc-members: :show-inheritance: -GrampsDbUndoList -==================================== - -.. autoclass:: GrampsDbUndoList - :members: - :undoc-members: - :show-inheritance: - -GrampsDbUndoBSDDB -==================================== - -.. autoclass:: GrampsDbUndoBSDDB - :members: - :undoc-members: - :show-inheritance: - -***************************** -Dbconst object -***************************** - DbConst ==================================== .. automodule:: gen.db.dbconst :members: -***************************** -Exceptions object -***************************** - GrampsDbException ==================================== .. automodule:: gen.db.exceptions -.. autoclass:: GrampsDbException :members: :undoc-members: :show-inheritance: -GrampsDbWriteFailure -==================================== -.. autoclass:: GrampsDbWriteFailure - :members: - :undoc-members: - :show-inheritance: - -FileVersionError -==================================== - -.. autoclass:: FileVersionError - :members: - :undoc-members: - :show-inheritance: - -FileVersionDeclineToUpgrade -==================================== - -.. autoclass:: FileVersionDeclineToUpgrade - :members: - :undoc-members: - :show-inheritance: - -***************************** Upgrade utilities -***************************** - +==================================== .. automodule:: gen.db.upgrade :members: :undoc-members: diff --git a/docs/gen/gen_display.rst b/docs/gen/gen_display.rst new file mode 100644 index 000000000..6c1f2313d --- /dev/null +++ b/docs/gen/gen_display.rst @@ -0,0 +1,12 @@ +############################# +The :mod:`gen.display` Module +############################# + +.. automodule:: gen.display + +Name +==================================== +.. automodule:: gen.display.name + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/gen/gen_lib.rst b/docs/gen/gen_lib.rst index 3151f18c8..40e70524b 100644 --- a/docs/gen/gen_lib.rst +++ b/docs/gen/gen_lib.rst @@ -2,8 +2,6 @@ The :mod:`gen.lib` Module ########################## -Contents: - .. automodule:: gen.lib ***************************** diff --git a/docs/gen/gen_plug.rst b/docs/gen/gen_plug.rst index 1fbb79286..e23f0dce4 100644 --- a/docs/gen/gen_plug.rst +++ b/docs/gen/gen_plug.rst @@ -2,118 +2,228 @@ The :mod:`gen.plug` Module ############################ -Contents: - .. automodule:: gen.plug -***************************** -Plugins objects -***************************** - Plugin ==================================== -.. automodule:: gen.plug.Plugin -.. autoclass:: gen.plug.Plugin +.. automodule:: gen.plug._plugin :members: :undoc-members: :show-inheritance: BaseManager ==================================== -.. automodule:: gen.plug.BaseManager -.. autoclass:: gen.plug.BasePluginManager +.. automodule:: gen.plug._manager :members: :undoc-members: :show-inheritance: Docgen ==================================== -.. automodule:: gen.plug.Docgen -.. autoclass:: gen.plug.DocGenPlugin +.. automodule:: gen.plug._docgenplugin :members: :undoc-members: :show-inheritance: Export ==================================== -.. automodule:: gen.plug.Export -.. autoclass:: gen.plug.ExportPlugin +.. automodule:: gen.plug._export :members: :undoc-members: :show-inheritance: Gramplet ==================================== -.. automodule:: gen.plug.Gramplet -.. autoclass:: gen.plug.Gramplet +.. automodule:: gen.plug._gramplet :members: :undoc-members: :show-inheritance: Import ==================================== -.. automodule:: gen.plug.Import -.. autoclass:: gen.plug.ImportPlugin +.. automodule:: gen.plug._import :members: :undoc-members: :show-inheritance: Options ==================================== -.. automodule:: gen.plug.Options -.. autoclass:: gen.plug.Options +.. automodule:: gen.plug._options :members: :undoc-members: :show-inheritance: Register ==================================== -.. automodule:: gen.plug.Register -.. autoclass:: gen.plug.PluginRegister +.. automodule:: gen.plug._pluginreg :members: :undoc-members: :show-inheritance: Utils ==================================== -.. automodule:: gen.plug.Utils +.. automodule:: gen.plug.utils :members: :undoc-members: :show-inheritance: Docbackend ==================================== -.. automodule:: gen.plug.docbackend +.. automodule:: gen.plug.docbackend.cairobackend + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.plug.docbackend.docbackend :members: :undoc-members: :show-inheritance: - -**TODO** DocGen ==================================== -.. automodule:: gen.plug.docgen +.. automodule:: gen.plug.docgen.basedoc + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.plug.docgen.drawdoc + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.plug.docgen.fontscale + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.plug.docgen.fontstyle + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.plug.docgen.graphdoc + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.plug.docgen.graphicstyle + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.plug.docgen.paperstyle + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.plug.docgen.paragraphstyle + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.plug.docgen.stylesheet + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.plug.docgen.tablestyle + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.plug.docgen.textdoc :members: :undoc-members: :show-inheritance: - -**TODO** Menu ==================================== -.. automodule:: gen.plug.menu +.. automodule:: gen.plug.menu._boolean + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.plug.menu._booleanlist + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.plug.menu._color + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.plug.menu._destination + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.plug.menu._enumeratedlist + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.plug.menu._family + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.plug.menu._filter + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.plug.menu._media + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.plug.menu._note + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.plug.menu._number + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.plug.menu._option + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.plug.menu._person + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.plug.menu._personlist + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.plug.menu._placelist + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.plug.menu._string + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.plug.menu._style + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.plug.menu._surnamecolor + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.plug.menu._text :members: :undoc-members: :show-inheritance: - -**TODO** Report ==================================== -.. automodule:: gen.plug.report +.. automodule:: gen.plug.report._bibliography + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.plug.report._constants + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.plug.report.endnotes + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.plug.report._paper + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.plug.report._reportbase + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.plug.report.utils :members: :undoc-members: :show-inheritance: -**TODO** - diff --git a/docs/gen/gen_proxy.rst b/docs/gen/gen_proxy.rst index 52fbefd59..facbde894 100644 --- a/docs/gen/gen_proxy.rst +++ b/docs/gen/gen_proxy.rst @@ -2,8 +2,43 @@ The :mod:`gen.proxy` Module ############################ -Contents: - .. automodule:: gen.proxy -**TODO** +Proxy Base +==================================== +.. automodule:: gen.proxy.proxybase + :members: + :undoc-members: + :show-inheritance: + +Filter +==================================== +.. automodule:: gen.proxy.filter + :members: + :undoc-members: + :show-inheritance: + +Living +==================================== +.. automodule:: gen.proxy.living + :members: + :undoc-members: + :show-inheritance: + +Private +==================================== +.. automodule:: gen.proxy.private + :members: + :undoc-members: + :show-inheritance: + +References +==================================== +.. automodule:: gen.proxy.referenced + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.proxy.referencedbyselection + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/gen/gen_utils.rst b/docs/gen/gen_utils.rst index 93e9aec3d..2debccd96 100644 --- a/docs/gen/gen_utils.rst +++ b/docs/gen/gen_utils.rst @@ -2,8 +2,21 @@ The :mod:`gen.utils` Module ############################ -Contents: - .. automodule:: gen.utils -**TODO** +Utils +==================================== +.. automodule:: gen.utils.callman + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.utils.configmanager + :members: + :undoc-members: + :show-inheritance: +.. automodule:: gen.utils.fallback + :members: + :undoc-members: + :show-inheritance: + +