From 9577bd2beb8c857efdd1ee6b955def7fea4e2a02 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C5=81ukasz=20Nowak?= <luke@nexedi.com> Date: Wed, 16 Nov 2011 17:24:12 +0100 Subject: [PATCH] Document interface too. --- documentation/source/conf.py | 4 +-- documentation/source/index.rst | 1 + documentation/source/slap.rst | 46 ++++++++++++++++++++++++++++++++++ 3 files changed, 49 insertions(+), 2 deletions(-) create mode 100644 documentation/source/slap.rst diff --git a/documentation/source/conf.py b/documentation/source/conf.py index 229a5ab28..13f735e46 100644 --- a/documentation/source/conf.py +++ b/documentation/source/conf.py @@ -16,13 +16,13 @@ import sys, os # 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 # documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.append(os.path.abspath('.')) +sys.path.append(os.path.abspath('../../')) # -- 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.intersphinx', 'sphinx.ext.ifconfig'] +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.ifconfig', 'repoze.sphinx.autointerface'] # Add any paths that contain templates here, relative to this directory. # templates_path = ['_templates'] diff --git a/documentation/source/index.rst b/documentation/source/index.rst index f27b2256d..d88858bff 100644 --- a/documentation/source/index.rst +++ b/documentation/source/index.rst @@ -12,6 +12,7 @@ Contents: :maxdepth: 2 rest.rst + slap.rst Indices and tables ================== diff --git a/documentation/source/slap.rst b/documentation/source/slap.rst new file mode 100644 index 000000000..c0e77e535 --- /dev/null +++ b/documentation/source/slap.rst @@ -0,0 +1,46 @@ +slap interface documentation +**************************** + +.. autointerface:: slapos.slap.interface.slap.IException + :members: + :undoc-members: + +.. autointerface:: slapos.slap.interface.slap.INotFoundError + :members: + :undoc-members: + +.. autointerface:: slapos.slap.interface.slap.IUnauthorized + :members: + :undoc-members: + +.. autointerface:: slapos.slap.interface.slap.IRequester + :members: + :undoc-members: + +.. autointerface:: slapos.slap.interface.slap.IBuildoutController + :members: + :undoc-members: + +.. autointerface:: slapos.slap.interface.slap.ISoftwareRelease + :members: + :undoc-members: + +.. autointerface:: slapos.slap.interface.slap.IComputerPartition + :members: + :undoc-members: + +.. autointerface:: slapos.slap.interface.slap.IComputer + :members: + :undoc-members: + +.. autointerface:: slapos.slap.interface.slap.IOpenOrder + :members: + :undoc-members: + +.. autointerface:: slapos.slap.interface.slap.ISupply + :members: + :undoc-members: + +.. autointerface:: slapos.slap.interface.slap.slap + :members: + :undoc-members: -- 2.30.9