diff --git a/docs/api.rst b/docs/api.rst index 1ae120b6a..0ba319cf4 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -15,6 +15,7 @@ Contents: :maxdepth: 2 gen/gen_lib + gen/gen gen/gen_db gen/gen_display gen/gen_plug diff --git a/docs/conf.py b/docs/conf.py index 10b1cd865..9e8bd37f9 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -46,16 +46,16 @@ master_doc = 'index' # General information about the project. project = u'Gramps' -copyright = u'2011, The Gramps Project' +copyright = u'2012, The Gramps Project' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. -version = '3.3' +version = '3.4' # The full version, including alpha/beta/rc tags. -release = '3.3.0' +release = '3.4.0' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/docs/corecli/cli.rst b/docs/corecli/cli.rst index 4786a9b85..ac5ba0f61 100644 --- a/docs/corecli/cli.rst +++ b/docs/corecli/cli.rst @@ -43,3 +43,12 @@ Gramps CLI :members: :undoc-members: :show-inheritance: + +***************************** +User +***************************** +.. automodule:: cli.user +.. autoclass:: User + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/coregui/gui.rst b/docs/coregui/gui.rst index f982d251d..d935d8aa3 100644 --- a/docs/coregui/gui.rst +++ b/docs/coregui/gui.rst @@ -4,6 +4,15 @@ The :mod:`gui` Module .. automodule:: gui +***************************** +Gramps +***************************** +.. automodule:: gui.grampsgui +.. autoclass:: Gramps + :members: + :undoc-members: + :show-inheritance: + ***************************** About Dialog ***************************** @@ -145,5 +154,71 @@ Filter Editor :show-inheritance: ***************************** -Todo +Gramps Bar ***************************** +.. automodule:: gui.grampsbar +.. autoclass:: DetachedWindow + :members: + :undoc-members: + :show-inheritance: +.. autoclass:: GrampsBar + :members: + :undoc-members: + :show-inheritance: +.. autoclass:: TabGramplet + :members: + :undoc-members: + :show-inheritance: + +***************************** +Navigator +***************************** +.. automodule:: gui.navigator +.. autoclass:: Navigator + :members: + :undoc-members: + :show-inheritance: + +***************************** +Plugins Manager +***************************** +.. automodule:: gui.pluginmanager +.. autoclass:: GuiPluginManager + :members: + :undoc-members: + :show-inheritance: + +***************************** +User +***************************** +.. automodule:: gui.user +.. autoclass:: User + :members: + :undoc-members: + :show-inheritance: + +***************************** +Utils +***************************** +.. automodule:: gui.utils +.. autoclass:: CLIDialog + :members: + :undoc-members: + :show-inheritance: +.. autoclass:: CLIVbox + :members: + :undoc-members: + :show-inheritance: +.. autoclass:: ProgressMeter + :members: + :undoc-members: + :show-inheritance: + +***************************** +Views Manager +***************************** +.. automodule:: gui.viewmanager +.. autoclass:: ViewManager + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/gen/gen.rst b/docs/gen/gen.rst new file mode 100644 index 000000000..c5b7c9840 --- /dev/null +++ b/docs/gen/gen.rst @@ -0,0 +1,23 @@ +########################## +The :mod:`gen` Module +########################## + +.. automodule:: gen + +***************************** +Update callback +***************************** +.. automodule:: gen.updatecallback +.. autoclass:: UpdateCallback + :members: + :undoc-members: + :show-inheritance: + +***************************** +User +***************************** +.. automodule:: gen.user +.. autoclass:: User + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/gen/gen_plug.rst b/docs/gen/gen_plug.rst index e23f0dce4..e5d0c3af7 100644 --- a/docs/gen/gen_plug.rst +++ b/docs/gen/gen_plug.rst @@ -127,6 +127,10 @@ DocGen Menu ==================================== +.. automodule:: gen.plug.menu._menu + :members: + :undoc-members: + :show-inheritance: .. automodule:: gen.plug.menu._boolean :members: :undoc-members: @@ -202,6 +206,10 @@ Menu Report ==================================== +.. automodule:: gen.plug.report._options + :members: + :undoc-members: + :show-inheritance: .. automodule:: gen.plug.report._bibliography :members: :undoc-members: