From b6304dfc4f199fdc350899b74eb3ac29980de151 Mon Sep 17 00:00:00 2001 From: Raoul Snyman Date: Fri, 12 Mar 2010 17:43:42 +0200 Subject: [PATCH 1/2] Added bibles documentation. --- documentation/source/plugins/bibles.rst | 92 +++++++++++++++++++++++++ 1 file changed, 92 insertions(+) create mode 100644 documentation/source/plugins/bibles.rst diff --git a/documentation/source/plugins/bibles.rst b/documentation/source/plugins/bibles.rst new file mode 100644 index 000000000..d374c1e97 --- /dev/null +++ b/documentation/source/plugins/bibles.rst @@ -0,0 +1,92 @@ +.. _plugins-bibles: + +:mod:`bibles` Plugin +==================== + +.. automodule:: openlp.plugins.bibles + :members: + +:mod:`BiblePlugin` Class +------------------------- + +.. autoclass:: openlp.plugins.bibles.bibleplugin.BiblePlugin + :members: + +:mod:`forms` Submodule +---------------------- + +.. automodule:: openlp.plugins.bibles.forms + :members: + +:mod:`BibleImportWizard` +^^^^^^^^^^^^^^^^^^^^^^^^ + +.. autoclass:: openlp.plugins.bibles.forms.bibleimportwizard.Ui_BibleImportWizard + :members: + +.. autoclass:: openlp.plugins.bibles.forms.importwizardform.ImportWizardForm + :members: + +:mod:`lib` Submodule +-------------------- + +.. automodule:: openlp.plugins.bibles.lib + :members: + +:mod:`db` +^^^^^^^^^ + +.. automodule:: openlp.plugins.bibles.lib.db + :members: + +.. autoclass:: openlp.plugins.bibles.lib.db.BibleDB + :members: + +:mod:`csv` +^^^^^^^^^^ + +.. automodule:: openlp.plugins.bibles.lib.csv + :members: + +.. autoclass:: openlp.plugins.bibles.lib.csv.CSVBible + :members: + +:mod:`http` +^^^^^^^^^^^ + +.. automodule:: openlp.plugins.bibles.lib.http + :members: + +.. autoclass:: openlp.plugins.bibles.lib.http.HTTPBible + :members: + +:mod:`bibleOSISimpl` +^^^^^^^^^^^^^^^^^^^^ + +.. automodule:: openlp.plugins.bibles.lib.bibleOSISimpl + :members: + +:mod:`biblestab` +^^^^^^^^^^^^^^^^ + +.. automodule:: openlp.plugins.bibles.lib.biblestab + :members: + +:mod:`common` +^^^^^^^^^^^^^ + +.. automodule:: openlp.plugins.bibles.lib.common + :members: + +:mod:`manager` +^^^^^^^^^^^^^^ + +.. automodule:: openlp.plugins.bibles.lib.manager + :members: + +:mod:`mediaitem` +^^^^^^^^^^^^^^^^ + +.. automodule:: openlp.plugins.bibles.lib.mediaitem + :members: + From f7d1fba359329cd1c5484a4741074d6a9537e9ee Mon Sep 17 00:00:00 2001 From: Raoul Snyman Date: Mon, 26 Apr 2010 21:22:10 +0200 Subject: [PATCH 2/2] Fixes to the docs. --- documentation/source/core/lib.rst | 6 ------ documentation/source/plugins/bibles.rst | 9 ++++++--- 2 files changed, 6 insertions(+), 9 deletions(-) diff --git a/documentation/source/core/lib.rst b/documentation/source/core/lib.rst index 146d0d934..37360a43a 100644 --- a/documentation/source/core/lib.rst +++ b/documentation/source/core/lib.rst @@ -18,12 +18,6 @@ .. autoclass:: openlp.core.lib.eventreceiver.EventReceiver :members: -:mod:`ListWithPreviews` ------------------------ - -.. autoclass:: openlp.core.lib.listwithpreviews.ListWithPreviews - :members: - :mod:`MediaManagerItem` ----------------------- diff --git a/documentation/source/plugins/bibles.rst b/documentation/source/plugins/bibles.rst index d374c1e97..c042feb56 100644 --- a/documentation/source/plugins/bibles.rst +++ b/documentation/source/plugins/bibles.rst @@ -45,10 +45,10 @@ :mod:`csv` ^^^^^^^^^^ -.. automodule:: openlp.plugins.bibles.lib.csv +.. automodule:: openlp.plugins.bibles.lib.csvbible :members: -.. autoclass:: openlp.plugins.bibles.lib.csv.CSVBible +.. autoclass:: openlp.plugins.bibles.lib.csvbible.CSVBible :members: :mod:`http` @@ -63,7 +63,10 @@ :mod:`bibleOSISimpl` ^^^^^^^^^^^^^^^^^^^^ -.. automodule:: openlp.plugins.bibles.lib.bibleOSISimpl +.. automodule:: openlp.plugins.bibles.lib.osis + :members: + +.. autoclass:: openlp.plugins.bibles.lib.osis.OSISBible :members: :mod:`biblestab`