def make_command_section(category_name, name, parser): section = utils.subcategory("rally %s %s" % (category_name, name)) section.extend(utils.parse_text(parser["description"])) if parser["parser"].arguments: defaults = get_defaults(parser["parser"].defaults["action_fn"]) section.extend(make_arguments_section( category_name, name, parser["parser"].arguments, defaults)) return section
def make_command_section(category_name, name, parser): section = utils.subcategory("rally %s %s" % (category_name, name)) section.extend(utils.parse_text(parser["description"])) if parser["parser"].arguments: defaults = get_defaults(parser["parser"].defaults["action_fn"]) section.extend( make_arguments_section(category_name, name, parser["parser"].arguments, defaults)) return section
def _make_plugin_base_section(self, base_cls, base_name=None): if base_name: title = ("%ss" % base_name if base_name[-1] != "y" else "%sies" % base_name[:-1]) subcategory_obj = subcategory(title) else: subcategory_obj = [] for p in sorted(base_cls.get_all(), key=lambda o: o.get_name()): subcategory_obj.append(self._make_plugin_section(p, base_name)) return subcategory_obj
def make_command_section(category_name, name, parser): # NOTE(andreykurilin): there is only one category in rally-manage, so # let's just hardcode it. cmd = "rally-manage" if category_name == "db" else "rally" section = subcategory("%s %s %s" % (cmd, category_name, name)) section.extend(parse_text(parser["description"])) if parser["parser"].arguments: defaults = get_defaults(parser["parser"].defaults["action_fn"]) section.extend(make_arguments_section( category_name, name, parser["parser"].arguments, defaults)) return section
def make_command_section(category_name, name, parser): # NOTE(andreykurilin): there is only one category in rally-manage, so # let's just hardcode it. cmd = "rally-manage" if category_name == "db" else "rally" section = utils.subcategory("%s %s %s" % (cmd, category_name, name)) section.extend(utils.parse_text(parser["description"])) if parser["parser"].arguments: defaults = get_defaults(parser["parser"].defaults["action_fn"]) section.extend( make_arguments_section(category_name, name, parser["parser"].arguments, defaults)) return section
def _make_plugin_base_section(self, base_cls, base_name=None): if base_name: title = ("%ss" % base_name if base_name[-1] != "y" else "%sies" % base_name[:-1]) subcategory_obj = utils.subcategory(title) else: subcategory_obj = [] for p in sorted(base_cls.get_all(), key=lambda o: o.get_name()): # do not display hidden contexts if p._meta_get("hidden", False): continue subcategory_obj.append(self._make_plugin_section(p, base_name)) return subcategory_obj
def make_plugin_section(plugin, base_name): subcategory_obj = subcategory("%s [%s]" % (plugin.get_name(), base_name)) info = plugin.get_info() if info["title"]: subcategory_obj.append(paragraph(info["title"])) if info["description"]: subcategory_obj.extend(parse_text(info["description"])) if info["namespace"]: subcategory_obj.append( paragraph("**Namespace**: %s" % info["namespace"])) if info["parameters"]: subcategory_obj.extend( parse_text(_make_pretty_parameters(info["parameters"]))) if info["returns"]: subcategory_obj.extend( parse_text("**Returns**:\n%s" % info["returns"])) filename = info["module"].replace(".", "/") ref = "https://github.com/openstack/rally/blob/master/%s.py" % filename subcategory_obj.extend( parse_text("**Module**:\n`%s`__\n\n__ %s" % (info["module"], ref))) return subcategory_obj
def make_plugin_section(plugin, base_name): subcategory_obj = subcategory("%s [%s]" % (plugin.get_name(), base_name)) info = plugin.get_info() if info["title"]: subcategory_obj.append(paragraph(info["title"])) if info["description"]: subcategory_obj.extend(parse_text(info["description"])) if info["namespace"]: subcategory_obj.append(paragraph( "**Namespace**: %s" % info["namespace"])) if info["parameters"]: subcategory_obj.extend(parse_text( _make_pretty_parameters(info["parameters"]))) if info["returns"]: subcategory_obj.extend(parse_text( "**Returns**:\n%s" % info["returns"])) filename = info["module"].replace(".", "/") ref = "https://github.com/openstack/rally/blob/master/%s.py" % filename subcategory_obj.extend(parse_text("**Module**:\n`%s`__\n\n__ %s" % (info["module"], ref))) return subcategory_obj