Commit 9577bd2b authored by Łukasz Nowak's avatar Łukasz Nowak

Document interface too.

parent 9930f49b
...@@ -16,13 +16,13 @@ import sys, os ...@@ -16,13 +16,13 @@ import sys, os
# 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.append(os.path.abspath('.')) sys.path.append(os.path.abspath('../../'))
# -- General configuration ----------------------------------------------------- # -- General configuration -----------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be extensions # Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. # 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. # Add any paths that contain templates here, relative to this directory.
# templates_path = ['_templates'] # templates_path = ['_templates']
......
...@@ -12,6 +12,7 @@ Contents: ...@@ -12,6 +12,7 @@ Contents:
:maxdepth: 2 :maxdepth: 2
rest.rst rest.rst
slap.rst
Indices and tables Indices and tables
================== ==================
......
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:
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment