diff --git a/documentation/api/source/core/index.rst b/documentation/api/source/core/index.rst index 38a98ab97..8555e1ebe 100644 --- a/documentation/api/source/core/index.rst +++ b/documentation/api/source/core/index.rst @@ -3,9 +3,13 @@ :mod:`core` Module ================== +.. automodule:: openlp.core + :members: + .. toctree:: :maxdepth: 2 lib theme - + ui + utils \ No newline at end of file diff --git a/documentation/api/source/core/lib.rst b/documentation/api/source/core/lib.rst index 5fc66200d..6ca952d7d 100644 --- a/documentation/api/source/core/lib.rst +++ b/documentation/api/source/core/lib.rst @@ -1,7 +1,7 @@ .. _core-lib: -:mod:`lib` Module -================= +Object Library +============== .. automodule:: openlp.core.lib :members: diff --git a/documentation/api/source/core/ui.rst b/documentation/api/source/core/ui.rst new file mode 100644 index 000000000..63db7478e --- /dev/null +++ b/documentation/api/source/core/ui.rst @@ -0,0 +1,27 @@ +.. _core-ui: + +User Interface +============== + +.. automodule:: openlp.core.ui + +Main Windows +------------ + +.. autoclass:: openlp.core.ui.mainwindow.MainWindow + :members: + +.. autoclass:: openlp.core.ui.maindisplay.MainDisplay + :members: + +Managers +-------- + +.. autoclass:: openlp.core.ui.servicemanager.ServiceManager + :members: + +.. autoclass:: openlp.core.ui.mediadockmanager.MediaDockManager + :members: + +.. autoclass:: openlp.core.ui.thememanager.ThemeManager + :members: diff --git a/documentation/api/source/core/utils.rst b/documentation/api/source/core/utils.rst new file mode 100644 index 000000000..d0c6a672b --- /dev/null +++ b/documentation/api/source/core/utils.rst @@ -0,0 +1,7 @@ +.. _core-utils: + +Utilities +========= + +.. automodule:: openlp.core.utils + :members: diff --git a/documentation/api/source/index.rst b/documentation/api/source/index.rst index cd64b13a1..e1aeebbab 100644 --- a/documentation/api/source/index.rst +++ b/documentation/api/source/index.rst @@ -15,7 +15,6 @@ Contents: .. toctree:: :maxdepth: 2 - openlp core/index plugins/index diff --git a/documentation/api/source/plugins/custom.rst b/documentation/api/source/plugins/custom.rst new file mode 100644 index 000000000..f50b86d41 --- /dev/null +++ b/documentation/api/source/plugins/custom.rst @@ -0,0 +1,34 @@ +.. _plugins-custom: + +Custom Slides Plugin +==================== + +.. automodule:: openlp.plugins.custom + :members: + +Plugin Class +------------ + +.. autoclass:: openlp.plugins.custom.customplugin.CustomPlugin + :members: + +Forms +----- + +.. automodule:: openlp.plugins.custom.forms + :members: + +.. autoclass:: openlp.plugins.custom.forms.editcustomform.EditCustomForm + :members: + +.. autoclass:: openlp.plugins.custom.forms.editcustomslideform.EditCustomSlideForm + :members: + +Helper Classes & Functions +-------------------------- + +.. automodule:: openlp.plugins.custom.lib + :members: + +.. automodule:: openlp.plugins.custom.lib.mediaitem + :members: diff --git a/documentation/api/source/plugins/index.rst b/documentation/api/source/plugins/index.rst index 6c5b139d5..ee248b1a0 100644 --- a/documentation/api/source/plugins/index.rst +++ b/documentation/api/source/plugins/index.rst @@ -1,7 +1,7 @@ .. _plugins-index: -:mod:`plugins` Module -===================== +Plugins +======= .. automodule:: openlp.plugins :members: @@ -14,15 +14,6 @@ presentations media images - -:mod:`custom` Plugin --------------------- - -.. automodule:: openlp.plugins.custom - :members: - -:mod:`songusage` Plugin ------------------------ - -.. automodule:: openlp.plugins.songusage - :members: + custom + remotes + songusage diff --git a/documentation/api/source/plugins/remotes.rst b/documentation/api/source/plugins/remotes.rst new file mode 100644 index 000000000..0bcd37119 --- /dev/null +++ b/documentation/api/source/plugins/remotes.rst @@ -0,0 +1,19 @@ +.. _plugins-remotes: + +Remotes Plugin +============== + +.. automodule:: openlp.plugins.remotes + :members: + +Plugin Class +------------ + +.. autoclass:: openlp.plugins.remotes.remoteplugin.RemotesPlugin + :members: + +Helper Classes & Functions +-------------------------- + +.. automodule:: openlp.plugins.remotes.lib + :members: diff --git a/documentation/api/source/plugins/songusage.rst b/documentation/api/source/plugins/songusage.rst new file mode 100644 index 000000000..8d11eee34 --- /dev/null +++ b/documentation/api/source/plugins/songusage.rst @@ -0,0 +1,25 @@ +.. _plugins-songusage: + +Song Usage Plugin +================= + +.. automodule:: openlp.plugins.songusage + :members: + +Plugin Class +------------ + +.. autoclass:: openlp.plugins.songusage.songusageplugin.SongUsagePlugin + :members: + +Forms +----- + +.. automodule:: openlp.plugins.songusage.forms + :members: + +Helper Classes & Functions +-------------------------- + +.. automodule:: openlp.plugins.songusage.lib + :members: diff --git a/openlp/core/ui/__init__.py b/openlp/core/ui/__init__.py index 80d677386..fa704752e 100644 --- a/openlp/core/ui/__init__.py +++ b/openlp/core/ui/__init__.py @@ -39,7 +39,6 @@ class HideMode(object): from filerenameform import FileRenameForm from maindisplay import MainDisplay -from slidecontroller import HideMode from servicenoteform import ServiceNoteForm from serviceitemeditform import ServiceItemEditForm from screen import ScreenList diff --git a/openlp/core/ui/maindisplay.py b/openlp/core/ui/maindisplay.py index 0c9d8734f..782ed4cf6 100644 --- a/openlp/core/ui/maindisplay.py +++ b/openlp/core/ui/maindisplay.py @@ -90,6 +90,9 @@ class DisplayWidget(QtGui.QGraphicsView): event.ignore() class MainDisplay(DisplayWidget): + """ + This is the display screen. + """ def __init__(self, parent, screens, live): DisplayWidget.__init__(self, live, parent=None)