瀏覽代碼

begin XML-RPC API docs

Chris McDonough 15 年之前
父節點
當前提交
674109eadc
共有 2 個文件被更改,包括 20 次插入10 次删除
  1. 9 10
      docs/api.rst
  2. 11 0
      docs/conf.py

+ 9 - 10
docs/api.rst

@@ -1,14 +1,13 @@
-API Documentation for repoze.atemplate
-======================================
+XML-RPC API Documentation
+=========================
 
-Interfaces
-----------
+.. automodule:: supervisor.rpcinterface
 
-Document interfaces here.  You may want to use the ``.. autointerface::``
-directive provided by :mod:`repoze.sphinx.autointerface`, in which case
-you will need to add it to the extensions in `conf.py`.
+Status and Control
+------------------
 
-Exceptions
-----------
+  .. autoclass:: SupervisorNamespaceRPCInterface
 
-Document any custom exceptions here.
+    .. automethod:: getAPIVersion
+
+    .. automethod:: getSupervisorVersion

+ 11 - 0
docs/conf.py

@@ -19,6 +19,17 @@ import sys, os
 # make it absolute, like shown here.
 #sys.path.append(os.path.abspath('some/directory'))
 
+parent = os.path.dirname(os.path.dirname(__file__))
+sys.path.append(os.path.join(os.path.abspath(parent), 'src'))
+wd = os.getcwd()
+os.chdir(parent)
+os.system('%s setup.py test -q' % sys.executable)
+os.chdir(wd)
+
+for item in os.listdir(parent):
+    if item.endswith('.egg'):
+        sys.path.append(os.path.join(parent, item))
+
 # General configuration
 # ---------------------