Commits

Kai Diefenbach committed 23ab8fb

Added autodoc to doc.

  • Participants
  • Parent commits 61af9cb

Comments (0)

Files changed (2)

File docs/conf.py

 # 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.
 
+os.environ["DJANGO_SETTINGS_MODULE"] = "settings"
+DIRNAME = os.path.dirname(__file__)
+sys.path[0:0] = [
+    DIRNAME + '/../../../eggs/Django-1.3.1-py2.7.egg',
+    DIRNAME + '/../../../lfs_project',
+    DIRNAME + '/../../../parts/lfs',
+]
+
 # -- General configuration -----------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 # extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo']
 
+extensions = ['sphinx.ext.autodoc']
+
 if not on_rtd:
-    extensions = [ 'sphinxcontrib.spelling' ]
+    extensions.append('sphinxcontrib.spelling')
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

File docs/developer/api.rst

+===
+API
+===
+
+This is the public API of LFS. All changes of this will go through proper
+deprecation procesess and will be announced explictly within the release notes.
+
+PaymentMethod
+=============
+
+.. autoclass:: lfs.plugins.PaymentMethod
+
+    .. automethod:: lfs.plugins.PaymentMethod.process
+
+    .. automethod:: lfs.plugins.PaymentMethod.get_create_order_time
+
+    .. automethod:: lfs.plugins.PaymentMethod.get_pay_link
+
+OrderNumberGenerator
+====================
+
+.. autoclass:: lfs.plugins.OrderNumberGenerator
+
+    .. automethod:: lfs.plugins.OrderNumberGenerator.get_next