Some minor fixes for the API docs.

bzr-revno: 102
This commit is contained in:
Raoul Snyman 2012-06-15 21:11:45 +02:00
commit 1fb61d65f4
3 changed files with 16 additions and 11 deletions

View File

@ -17,7 +17,9 @@ import sys
# If extensions (or modules to document with autodoc) are in another directory, # If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the # add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here. # documentation root, use os.path.abspath to make it absolute, like shown here.
sys.path.insert(0, os.path.abspath(os.path.join('..', '..', '..'))) path_to_code = os.path.abspath(os.path.join(os.path.split(__file__)[0],
'..', '..', '..', '..', 'OpenLP', 'trunk'))
sys.path.insert(0, path_to_code)
# -- General configuration ----------------------------------------------------- # -- General configuration -----------------------------------------------------

View File

@ -1,10 +1,10 @@
.. _core-index: .. _core-index:
:mod:`core` Module Core Application
================== ================
.. automodule:: openlp.core This is the core of the OpenLP application. Anything that is not a plugin is
:members: stored in the :mod:`~openlp.core` module.
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
@ -12,4 +12,7 @@
lib lib
theme theme
ui ui
utils utils
.. automodule:: openlp.core
:members:

View File

@ -6,17 +6,17 @@ Media Plugin
.. automodule:: openlp.plugins.media .. automodule:: openlp.plugins.media
:members: :members:
Plugin Class Plugin Class
------------ ------------
.. autoclass:: openlp.plugins.media.mediaplugin.MediaPlugin .. autoclass:: openlp.plugins.media.mediaplugin.MediaPlugin
:members: :members:
Helper Classes & Functions Helper Classes & Functions
-------------------------- --------------------------
.. automodule:: openlp.plugins.media.lib .. automodule:: openlp.plugins.media.lib
:members: :members:
.. automodule:: openlp.plugins.media.lib.mediaitem .. automodule:: openlp.plugins.media.lib.mediaitem
:members: :members: