Commit d9b49c88 authored by Antoine Millet's avatar Antoine Millet
Browse files

Now use autosummary for summary of handler methods

parent 76915efb
Loading
Loading
Loading
Loading
+34 −33
Original line number Diff line number Diff line
@@ -18,42 +18,43 @@ MIGRATION_TYPES = {'cold': 'cold_migrate',


class CliHandler(RegisteredCCHandler):
    """ Handler binded to 'cli' role.
    """ Handler binded to the 'cli' role.

    Summary of methods:

    ================ ================================ =============
    Method name      Description                      Right(s)
    ================ ================================ =============
    list             list objects                     list
    start            start a vm                       start
    stop             stop a vm                        stop
    destroy          destroy a vm                     destroy
    pause            suspend a vm                     pause
    resume           resume a paused vm               resume
    passwd           change password of accounts      passwd
    addaccount       add a new account                addaccount
    copyaccount      copy an account                  addaccount
    addtag           add a tag to accounts            addtag
    deltag           remove a tag from accounts       deltag
    tags             show tags of accounts            tags
    delaccount       delete an account                delaccount
    close            close an account                 close
    declose          declose an account               declose
    kill             kill a connected account         kill
    rights           show rights of accounts          rights
    addright         add right rules to accounts      addright
    delright         remove right rules from accounts delright
    execute          execute remote command on hosts  execute
    shutdown         shutdown a connected client      shutdown
    jobs             show jobs                        jobs
    cancel           cancel a running job             cancel
    jobspurge        remove done jobs from jobs list  jobspurge
    rshell           start a remote shell             rshell
    rshell_resize    send a resize signal to the tty  rshell
    rshell_wait      wait for a rshell termination    rshell
    forward          forward a port to a remote node  forward
    ================ ================================ =============
    .. currentmodule:: cloudcontrol.server.clients.cli

    .. autosummary::
       :toctree: handler

       CliHandler.list
       CliHandler.start
       CliHandler.stop
       CliHandler.destroy
       CliHandler.pause
       CliHandler.resume
       CliHandler.passwd
       CliHandler.addaccount
       CliHandler.copyaccount
       CliHandler.addtag
       CliHandler.deltag
       CliHandler.tags
       CliHandler.delaccount
       CliHandler.close
       CliHandler.declose
       CliHandler.kill
       CliHandler.rights
       CliHandler.addright
       CliHandler.delright
       CliHandler.execute
       CliHandler.shutdown
       CliHandler.jobs
       CliHandler.cancel
       CliHandler.jobspurge
       CliHandler.rshell
       CliHandler.rshell_resize
       CliHandler.rshell_wait
       CliHandler.forward
    """

    @listed
+6 −1
Original line number Diff line number Diff line
@@ -22,7 +22,12 @@ sys.path.append(os.path.abspath('../'))

# 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.todo', 'sphinx.ext.pngmath', 'sphinx.ext.ifconfig']
extensions = ['sphinx.ext.autodoc',
              'sphinx.ext.autosummary',
              'sphinx.ext.intersphinx',
              'sphinx.ext.todo',
              'sphinx.ext.pngmath',
              'sphinx.ext.ifconfig',]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']