diff --git a/doc/actionsmap.png b/doc/actionsmap.png new file mode 100644 index 00000000..0778cb86 Binary files /dev/null and b/doc/actionsmap.png differ diff --git a/doc/actionsmap.rst b/doc/actionsmap.rst new file mode 100644 index 00000000..8e30123b --- /dev/null +++ b/doc/actionsmap.rst @@ -0,0 +1,31 @@ +================================= +Role and syntax of the actionsmap +================================= + +Principle +========= + +The actionsmap allows to easily define commands and their arguments through +a YAML file. Moulinette will automatically make the command available through +the CLI and Rest API, and will be mapped to a python function. + +The illustration below summarizes how it works : + +.. image:: actionsmap.png + + +Format of the actionmap +======================= + +General description of categories/subcategories, actions, arguments. + +Authentication configuration +---------------------------- + +Document the `configuration: authenticate: all` LDAP stuff ... + +Special options for arguments +----------------------------- + +Document `nargs`, `metavar`, `extra: pattern` + diff --git a/doc/index.rst b/doc/index.rst index 4e1baf6f..5715cb63 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -16,6 +16,7 @@ a reference. :maxdepth: 2 :caption: Contents: + actionsmap ldap m18n utils/filesystem