Skip to content

Commit 674109e

Browse files
committed
begin XML-RPC API docs
1 parent 632398e commit 674109e

File tree

2 files changed

+20
-10
lines changed

2 files changed

+20
-10
lines changed

docs/api.rst

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
1-
API Documentation for repoze.atemplate
2-
======================================
1+
XML-RPC API Documentation
2+
=========================
33

4-
Interfaces
5-
----------
4+
.. automodule:: supervisor.rpcinterface
65

7-
Document interfaces here. You may want to use the ``.. autointerface::``
8-
directive provided by :mod:`repoze.sphinx.autointerface`, in which case
9-
you will need to add it to the extensions in `conf.py`.
6+
Status and Control
7+
------------------
108

11-
Exceptions
12-
----------
9+
.. autoclass:: SupervisorNamespaceRPCInterface
1310

14-
Document any custom exceptions here.
11+
.. automethod:: getAPIVersion
12+
13+
.. automethod:: getSupervisorVersion

docs/conf.py

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,17 @@
1919
# make it absolute, like shown here.
2020
#sys.path.append(os.path.abspath('some/directory'))
2121

22+
parent = os.path.dirname(os.path.dirname(__file__))
23+
sys.path.append(os.path.join(os.path.abspath(parent), 'src'))
24+
wd = os.getcwd()
25+
os.chdir(parent)
26+
os.system('%s setup.py test -q' % sys.executable)
27+
os.chdir(wd)
28+
29+
for item in os.listdir(parent):
30+
if item.endswith('.egg'):
31+
sys.path.append(os.path.join(parent, item))
32+
2233
# General configuration
2334
# ---------------------
2435

0 commit comments

Comments
 (0)